include/tubes/file-transfer-helper.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * empathy-ft-handler.h - Header for EmpathyFTHandler
   4  * Copyright (C) 2009 Collabora Ltd.
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * Author: Cosimo Cecchi <cosimo.cecchi@collabora.co.uk>
  21  */
  22
  23 /* empathy-ft-handler.h */
  24
  25 #ifndef INCLUDED_TUBES_FILE_TRANSFER_HELPER_H
  26 #define INCLUDED_TUBES_FILE_TRANSFER_HELPER_H
  27
  28 #include <config_lgpl.h>
  29 #include <glib-object.h>
  30 #include <gio/gio.h>
  31
  32 #include <telepathy-glib/contact.h>
  33 #include <telepathy-glib/file-transfer-channel.h>
  34
  35 G_BEGIN_DECLS
  36
  37 #define EMPATHY_TYPE_FT_HANDLER empathy_ft_handler_get_type()
  38 #define EMPATHY_FT_HANDLER(obj) \
  39   (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
  40    EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandler))
  41 #define EMPATHY_FT_HANDLER_CLASS(klass) \
  42   (G_TYPE_CHECK_CLASS_CAST ((klass), \
  43    EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandlerClass))
  44 #define EMPATHY_IS_FT_HANDLER(obj) \
  45   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EMPATHY_TYPE_FT_HANDLER))
  46 #define EMPATHY_IS_FT_HANDLER_CLASS(klass) \
  47   (G_TYPE_CHECK_CLASS_TYPE ((klass), EMPATHY_TYPE_FT_HANDLER))
  48 #define EMPATHY_FT_HANDLER_GET_CLASS(obj) \
  49   (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  50    EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandlerClass))
  51
  52 typedef struct _EmpathyFTHandlerPriv EmpathyFTHandlerPriv;
  53
  54 typedef struct {
  55   GObject parent;
  56   EmpathyFTHandlerPriv *priv;
  57 } EmpathyFTHandler;
  58
  59 typedef struct {
  60   GObjectClass parent_class;
  61 } EmpathyFTHandlerClass;
  62
  63 #define EMPATHY_FT_ERROR_QUARK g_quark_from_static_string ("EmpathyFTError")
  64
  65 typedef enum {
  66         EMPATHY_FT_ERROR_FAILED,
  67         EMPATHY_FT_ERROR_HASH_MISMATCH,
  68         EMPATHY_FT_ERROR_TP_ERROR,
  69         EMPATHY_FT_ERROR_SOCKET,
  70         EMPATHY_FT_ERROR_NOT_SUPPORTED,
  71         EMPATHY_FT_ERROR_INVALID_SOURCE_FILE,
  72         EMPATHY_FT_ERROR_EMPTY_SOURCE_FILE
  73 } EmpathyFTErrorEnum;
  74
  75 /**
  76  * EmpathyFTHandlerReadyCallback:
  77  * @handler: the handler which is now ready
  78  * @error: a #GError if the operation failed, or %NULL
  79  * @user_data: user data passed to the callback
  80  */
  81 typedef void (* EmpathyFTHandlerReadyCallback) (EmpathyFTHandler *handler,
  82     GError *error,
  83     gpointer user_data);
  84
  85 GType empathy_ft_handler_get_type (void);
  86
  87 /* public methods */
  88 void empathy_ft_handler_new_outgoing (
  89     TpAccount *account,
  90     TpContact *contact,
  91     GFile *source,
  92     gint64 action_time,
  93     EmpathyFTHandlerReadyCallback callback,
  94     gpointer user_data);
  95 void empathy_ft_handler_set_service_name (
  96     EmpathyFTHandler *self,
  97     const gchar *service_name);
  98 void empathy_ft_handler_set_description (
  99     EmpathyFTHandler *self,
 100     const gchar *description);
 101
 102
 103 void empathy_ft_handler_new_incoming (TpFileTransferChannel *channel,
 104     EmpathyFTHandlerReadyCallback callback,
 105     gpointer user_data);
 106 void empathy_ft_handler_incoming_set_destination (EmpathyFTHandler *handler,
 107     GFile *destination);
 108
 109 void empathy_ft_handler_start_transfer (EmpathyFTHandler *handler);
 110 void empathy_ft_handler_cancel_transfer (EmpathyFTHandler *handler);
 111
 112 /* properties of the transfer */
 113 const char * empathy_ft_handler_get_filename (EmpathyFTHandler *handler);
 114 const char * empathy_ft_handler_get_content_type (EmpathyFTHandler *handler);
 115 TpContact * empathy_ft_handler_get_contact (EmpathyFTHandler *handler);
 116 GFile * empathy_ft_handler_get_gfile (EmpathyFTHandler *handler);
 117 const char *empathy_ft_handler_get_description(EmpathyFTHandler*);
 118 gboolean empathy_ft_handler_get_use_hash (EmpathyFTHandler *handler);
 119 gboolean empathy_ft_handler_is_incoming (EmpathyFTHandler *handler);
 120 guint64 empathy_ft_handler_get_transferred_bytes (EmpathyFTHandler *handler);
 121 guint64 empathy_ft_handler_get_total_bytes (EmpathyFTHandler *handler);
 122 gboolean empathy_ft_handler_is_completed (EmpathyFTHandler *handler);
 123 gboolean empathy_ft_handler_is_cancelled (EmpathyFTHandler *handler);
 124
 125 G_END_DECLS
 126
 127 #endif // INCLUDED_TUBES_FILE_TRANSFER_HELPER_H
 128
 129 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */