include/tubes/file-transfer-helper.h

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