empathy-ft-handler.h 3.92 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/*
 * empathy-ft-handler.h - Header for EmpathyFTHandler
 * Copyright (C) 2009 Collabora Ltd.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Author: Cosimo Cecchi <cosimo.cecchi@collabora.co.uk>
 */

/* empathy-ft-handler.h */

#ifndef __EMPATHY_FT_HANDLER_H__
#define __EMPATHY_FT_HANDLER_H__

#include <glib-object.h>
Cosimo Cecchi's avatar
Cosimo Cecchi committed
28 29
#include <gio/gio.h>

30 31
#include <telepathy-glib/file-transfer-channel.h>

Cosimo Cecchi's avatar
Cosimo Cecchi committed
32
#include "empathy-contact.h"
33 34 35 36 37

G_BEGIN_DECLS

#define EMPATHY_TYPE_FT_HANDLER empathy_ft_handler_get_type()
#define EMPATHY_FT_HANDLER(obj) \
38 39
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
   EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandler))
40
#define EMPATHY_FT_HANDLER_CLASS(klass) \
41 42
  (G_TYPE_CHECK_CLASS_CAST ((klass), \
   EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandlerClass))
43 44 45 46 47
#define EMPATHY_IS_FT_HANDLER(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EMPATHY_TYPE_FT_HANDLER))
#define EMPATHY_IS_FT_HANDLER_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), EMPATHY_TYPE_FT_HANDLER))
#define EMPATHY_FT_HANDLER_GET_CLASS(obj) \
48 49
  (G_TYPE_INSTANCE_GET_CLASS ((obj), \
   EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandlerClass))
50 51 52 53 54 55 56 57 58 59

typedef struct {
  GObject parent;
  gpointer priv;
} EmpathyFTHandler;

typedef struct {
  GObjectClass parent_class;
} EmpathyFTHandlerClass;

60 61 62 63 64 65 66 67 68 69 70 71
#define EMPATHY_FT_ERROR_QUARK g_quark_from_static_string ("EmpathyFTError")

typedef enum {
	EMPATHY_FT_ERROR_FAILED,
	EMPATHY_FT_ERROR_HASH_MISMATCH,
	EMPATHY_FT_ERROR_TP_ERROR,
	EMPATHY_FT_ERROR_SOCKET,
	EMPATHY_FT_ERROR_NOT_SUPPORTED,
	EMPATHY_FT_ERROR_INVALID_SOURCE_FILE,
	EMPATHY_FT_ERROR_EMPTY_SOURCE_FILE
} EmpathyFTErrorEnum;

72 73 74 75 76 77
/**
 * EmpathyFTHandlerReadyCallback:
 * @handler: the handler which is now ready
 * @error: a #GError if the operation failed, or %NULL
 * @user_data: user data passed to the callback
 */
78
typedef void (* EmpathyFTHandlerReadyCallback) (EmpathyFTHandler *handler,
79 80
    GError *error,
    gpointer user_data);
81

82 83 84
GType empathy_ft_handler_get_type (void);

/* public methods */
85
void empathy_ft_handler_new_outgoing (EmpathyContact *contact,
86
    GFile *source,
87
    gint64 action_time,
88
    EmpathyFTHandlerReadyCallback callback,
89
    gpointer user_data);
90

91
void empathy_ft_handler_new_incoming (TpFileTransferChannel *channel,
92 93
    EmpathyFTHandlerReadyCallback callback,
    gpointer user_data);
94
void empathy_ft_handler_incoming_set_destination (EmpathyFTHandler *handler,
95
    GFile *destination);
96

97 98
void empathy_ft_handler_start_transfer (EmpathyFTHandler *handler);
void empathy_ft_handler_cancel_transfer (EmpathyFTHandler *handler);
99

100
/* properties of the transfer */
101
const char * empathy_ft_handler_get_filename (EmpathyFTHandler *handler);
102 103 104
const char * empathy_ft_handler_get_content_type (EmpathyFTHandler *handler);
EmpathyContact * empathy_ft_handler_get_contact (EmpathyFTHandler *handler);
GFile * empathy_ft_handler_get_gfile (EmpathyFTHandler *handler);
105
gboolean empathy_ft_handler_get_use_hash (EmpathyFTHandler *handler);
106
gboolean empathy_ft_handler_is_incoming (EmpathyFTHandler *handler);
107
guint64 empathy_ft_handler_get_transferred_bytes (EmpathyFTHandler *handler);
108
guint64 empathy_ft_handler_get_total_bytes (EmpathyFTHandler *handler);
109 110
gboolean empathy_ft_handler_is_completed (EmpathyFTHandler *handler);
gboolean empathy_ft_handler_is_cancelled (EmpathyFTHandler *handler);
111

112 113 114
G_END_DECLS

#endif /* __EMPATHY_FT_HANDLER_H__ */