00001
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027 #ifndef _PURPLE_FT_H_
00028 #define _PURPLE_FT_H_
00029
00030
00032
00033 typedef struct _PurpleXfer PurpleXfer;
00034
00035 #include <glib.h>
00036 #include <stdio.h>
00037
00038 #include "account.h"
00039
00043 typedef enum
00044 {
00045 PURPLE_XFER_UNKNOWN = 0,
00046 PURPLE_XFER_SEND,
00047 PURPLE_XFER_RECEIVE
00049 } PurpleXferType;
00050
00054 typedef enum
00055 {
00056 PURPLE_XFER_STATUS_UNKNOWN = 0,
00057 PURPLE_XFER_STATUS_NOT_STARTED,
00058 PURPLE_XFER_STATUS_ACCEPTED,
00059 PURPLE_XFER_STATUS_STARTED,
00060 PURPLE_XFER_STATUS_DONE,
00061 PURPLE_XFER_STATUS_CANCEL_LOCAL,
00062 PURPLE_XFER_STATUS_CANCEL_REMOTE
00063 } PurpleXferStatusType;
00064
00071 typedef struct
00072 {
00073 void (*new_xfer)(PurpleXfer *xfer);
00074 void (*destroy)(PurpleXfer *xfer);
00075 void (*add_xfer)(PurpleXfer *xfer);
00076 void (*update_progress)(PurpleXfer *xfer, double percent);
00077 void (*cancel_local)(PurpleXfer *xfer);
00078 void (*cancel_remote)(PurpleXfer *xfer);
00079
00092 gssize (*ui_write)(PurpleXfer *xfer, const guchar *buffer, gssize size);
00093
00107 gssize (*ui_read)(PurpleXfer *xfer, guchar **buffer, gssize size);
00108
00121 void (*data_not_sent)(PurpleXfer *xfer, const guchar *buffer, gsize size);
00122
00128 void (*add_thumbnail)(PurpleXfer *xfer, const gchar *formats);
00129 } PurpleXferUiOps;
00130
00134 struct _PurpleXfer
00135 {
00136 guint ref;
00137 PurpleXferType type;
00139 PurpleAccount *account;
00141 char *who;
00144 char *message;
00145 char *filename;
00146 char *local_filename;
00147 size_t size;
00149 FILE *dest_fp;
00151 char *remote_ip;
00152 int local_port;
00153 int remote_port;
00155 int fd;
00156 int watcher;
00158 size_t bytes_sent;
00159 size_t bytes_remaining;
00160 time_t start_time;
00161 time_t end_time;
00163 size_t current_buffer_size;
00166 PurpleXferStatusType status;
00172 struct
00173 {
00174 void (*init)(PurpleXfer *xfer);
00175 void (*request_denied)(PurpleXfer *xfer);
00176 void (*start)(PurpleXfer *xfer);
00177 void (*end)(PurpleXfer *xfer);
00178 void (*cancel_send)(PurpleXfer *xfer);
00179 void (*cancel_recv)(PurpleXfer *xfer);
00180 gssize (*read)(guchar **buffer, PurpleXfer *xfer);
00181 gssize (*write)(const guchar *buffer, size_t size, PurpleXfer *xfer);
00182 void (*ack)(PurpleXfer *xfer, const guchar *buffer, size_t size);
00183 } ops;
00184
00185 PurpleXferUiOps *ui_ops;
00186 void *ui_data;
00188 void *data;
00189 };
00190
00191 #ifdef __cplusplus
00192 extern "C" {
00193 #endif
00194
00195
00197
00213 PurpleXfer *purple_xfer_new(PurpleAccount *account,
00214 PurpleXferType type, const char *who);
00215
00221 GList *purple_xfers_get_all(void);
00222
00229 void purple_xfer_ref(PurpleXfer *xfer);
00230
00240 void purple_xfer_unref(PurpleXfer *xfer);
00241
00251 void purple_xfer_request(PurpleXfer *xfer);
00252
00259 void purple_xfer_request_accepted(PurpleXfer *xfer, const char *filename);
00260
00266 void purple_xfer_request_denied(PurpleXfer *xfer);
00267
00275 PurpleXferType purple_xfer_get_type(const PurpleXfer *xfer);
00276
00284 PurpleAccount *purple_xfer_get_account(const PurpleXfer *xfer);
00285
00295 const char *purple_xfer_get_remote_user(const PurpleXfer *xfer);
00296
00304 PurpleXferStatusType purple_xfer_get_status(const PurpleXfer *xfer);
00305
00313 gboolean purple_xfer_is_canceled(const PurpleXfer *xfer);
00314
00322 gboolean purple_xfer_is_completed(const PurpleXfer *xfer);
00323
00331 const char *purple_xfer_get_filename(const PurpleXfer *xfer);
00332
00340 const char *purple_xfer_get_local_filename(const PurpleXfer *xfer);
00341
00349 size_t purple_xfer_get_bytes_sent(const PurpleXfer *xfer);
00350
00358 size_t purple_xfer_get_bytes_remaining(const PurpleXfer *xfer);
00359
00367 size_t purple_xfer_get_size(const PurpleXfer *xfer);
00368
00378 double purple_xfer_get_progress(const PurpleXfer *xfer);
00379
00387 unsigned int purple_xfer_get_local_port(const PurpleXfer *xfer);
00388
00396 const char *purple_xfer_get_remote_ip(const PurpleXfer *xfer);
00397
00405 unsigned int purple_xfer_get_remote_port(const PurpleXfer *xfer);
00406
00415 time_t purple_xfer_get_start_time(const PurpleXfer *xfer);
00416
00425 time_t purple_xfer_get_end_time(const PurpleXfer *xfer);
00426
00433 void purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed);
00434
00441 void purple_xfer_set_message(PurpleXfer *xfer, const char *message);
00442
00449 void purple_xfer_set_filename(PurpleXfer *xfer, const char *filename);
00450
00457 void purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename);
00458
00465 void purple_xfer_set_size(PurpleXfer *xfer, size_t size);
00466
00480 void purple_xfer_set_bytes_sent(PurpleXfer *xfer, size_t bytes_sent);
00481
00489 PurpleXferUiOps *purple_xfer_get_ui_ops(const PurpleXfer *xfer);
00490
00497 void purple_xfer_set_read_fnc(PurpleXfer *xfer,
00498 gssize (*fnc)(guchar **, PurpleXfer *));
00499
00506 void purple_xfer_set_write_fnc(PurpleXfer *xfer,
00507 gssize (*fnc)(const guchar *, size_t, PurpleXfer *));
00508
00515 void purple_xfer_set_ack_fnc(PurpleXfer *xfer,
00516 void (*fnc)(PurpleXfer *, const guchar *, size_t));
00517
00524 void purple_xfer_set_request_denied_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00525
00536 void purple_xfer_set_init_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00537
00544 void purple_xfer_set_start_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00545
00552 void purple_xfer_set_end_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00553
00560 void purple_xfer_set_cancel_send_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00561
00568 void purple_xfer_set_cancel_recv_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00569
00578 gssize purple_xfer_read(PurpleXfer *xfer, guchar **buffer);
00579
00589 gssize purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size);
00590
00609 void purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip,
00610 unsigned int port);
00611
00617 void purple_xfer_end(PurpleXfer *xfer);
00618
00625 void purple_xfer_add(PurpleXfer *xfer);
00626
00632 void purple_xfer_cancel_local(PurpleXfer *xfer);
00633
00639 void purple_xfer_cancel_remote(PurpleXfer *xfer);
00640
00653 void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg);
00654
00660 void purple_xfer_update_progress(PurpleXfer *xfer);
00661
00671 void purple_xfer_conversation_write(PurpleXfer *xfer, char *message, gboolean is_error);
00672
00682 void purple_xfer_ui_ready(PurpleXfer *xfer);
00683
00693 void purple_xfer_prpl_ready(PurpleXfer *xfer);
00694
00704 gconstpointer purple_xfer_get_thumbnail(const PurpleXfer *xfer, gsize *len);
00705
00713 const gchar *purple_xfer_get_thumbnail_mimetype(const PurpleXfer *xfer);
00714
00715
00725 void purple_xfer_set_thumbnail(PurpleXfer *xfer, gconstpointer thumbnail,
00726 gsize size, const gchar *mimetype);
00727
00737 void purple_xfer_prepare_thumbnail(PurpleXfer *xfer, const gchar *formats);
00738
00739
00742
00744
00752 void *purple_xfers_get_handle(void);
00753
00757 void purple_xfers_init(void);
00758
00762 void purple_xfers_uninit(void);
00763
00769 void purple_xfers_set_ui_ops(PurpleXferUiOps *ops);
00770
00776 PurpleXferUiOps *purple_xfers_get_ui_ops(void);
00777
00780 #ifdef __cplusplus
00781 }
00782 #endif
00783
00784 #endif