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
00123 void (*_purple_reserved1)(void);
00124 } PurpleXferUiOps;
00125
00129 struct _PurpleXfer
00130 {
00131 guint ref;
00132 PurpleXferType type;
00134 PurpleAccount *account;
00136 char *who;
00139 char *message;
00140 char *filename;
00141 char *local_filename;
00142 size_t size;
00144 FILE *dest_fp;
00146 char *remote_ip;
00147 int local_port;
00148 int remote_port;
00150 int fd;
00151 int watcher;
00153 size_t bytes_sent;
00154 size_t bytes_remaining;
00155 time_t start_time;
00156 time_t end_time;
00158 size_t current_buffer_size;
00161 PurpleXferStatusType status;
00163
00164 struct
00165 {
00166 void (*init)(PurpleXfer *xfer);
00167 void (*request_denied)(PurpleXfer *xfer);
00168 void (*start)(PurpleXfer *xfer);
00169 void (*end)(PurpleXfer *xfer);
00170 void (*cancel_send)(PurpleXfer *xfer);
00171 void (*cancel_recv)(PurpleXfer *xfer);
00172 gssize (*read)(guchar **buffer, PurpleXfer *xfer);
00173 gssize (*write)(const guchar *buffer, size_t size, PurpleXfer *xfer);
00174 void (*ack)(PurpleXfer *xfer, const guchar *buffer, size_t size);
00175 } ops;
00176
00177 PurpleXferUiOps *ui_ops;
00178 void *ui_data;
00180 void *data;
00181 };
00182
00183 #ifdef __cplusplus
00184 extern "C" {
00185 #endif
00186
00187
00189
00205 PurpleXfer *purple_xfer_new(PurpleAccount *account,
00206 PurpleXferType type, const char *who);
00207
00213 GList *purple_xfers_get_all(void);
00214
00221 void purple_xfer_ref(PurpleXfer *xfer);
00222
00232 void purple_xfer_unref(PurpleXfer *xfer);
00233
00243 void purple_xfer_request(PurpleXfer *xfer);
00244
00251 void purple_xfer_request_accepted(PurpleXfer *xfer, const char *filename);
00252
00258 void purple_xfer_request_denied(PurpleXfer *xfer);
00259
00267 PurpleXferType purple_xfer_get_type(const PurpleXfer *xfer);
00268
00276 PurpleAccount *purple_xfer_get_account(const PurpleXfer *xfer);
00277
00287 const char *purple_xfer_get_remote_user(const PurpleXfer *xfer);
00288
00296 PurpleXferStatusType purple_xfer_get_status(const PurpleXfer *xfer);
00297
00305 gboolean purple_xfer_is_canceled(const PurpleXfer *xfer);
00306
00314 gboolean purple_xfer_is_completed(const PurpleXfer *xfer);
00315
00323 const char *purple_xfer_get_filename(const PurpleXfer *xfer);
00324
00332 const char *purple_xfer_get_local_filename(const PurpleXfer *xfer);
00333
00341 size_t purple_xfer_get_bytes_sent(const PurpleXfer *xfer);
00342
00350 size_t purple_xfer_get_bytes_remaining(const PurpleXfer *xfer);
00351
00359 size_t purple_xfer_get_size(const PurpleXfer *xfer);
00360
00370 double purple_xfer_get_progress(const PurpleXfer *xfer);
00371
00379 unsigned int purple_xfer_get_local_port(const PurpleXfer *xfer);
00380
00388 const char *purple_xfer_get_remote_ip(const PurpleXfer *xfer);
00389
00397 unsigned int purple_xfer_get_remote_port(const PurpleXfer *xfer);
00398
00407 time_t purple_xfer_get_start_time(const PurpleXfer *xfer);
00408
00417 time_t purple_xfer_get_end_time(const PurpleXfer *xfer);
00418
00425 void purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed);
00426
00433 void purple_xfer_set_message(PurpleXfer *xfer, const char *message);
00434
00441 void purple_xfer_set_filename(PurpleXfer *xfer, const char *filename);
00442
00449 void purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename);
00450
00457 void purple_xfer_set_size(PurpleXfer *xfer, size_t size);
00458
00472 void purple_xfer_set_bytes_sent(PurpleXfer *xfer, size_t bytes_sent);
00473
00481 PurpleXferUiOps *purple_xfer_get_ui_ops(const PurpleXfer *xfer);
00482
00489 void purple_xfer_set_read_fnc(PurpleXfer *xfer,
00490 gssize (*fnc)(guchar **, PurpleXfer *));
00491
00498 void purple_xfer_set_write_fnc(PurpleXfer *xfer,
00499 gssize (*fnc)(const guchar *, size_t, PurpleXfer *));
00500
00507 void purple_xfer_set_ack_fnc(PurpleXfer *xfer,
00508 void (*fnc)(PurpleXfer *, const guchar *, size_t));
00509
00516 void purple_xfer_set_request_denied_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00517
00528 void purple_xfer_set_init_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00529
00536 void purple_xfer_set_start_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00537
00544 void purple_xfer_set_end_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00545
00552 void purple_xfer_set_cancel_send_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00553
00560 void purple_xfer_set_cancel_recv_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00561
00570 gssize purple_xfer_read(PurpleXfer *xfer, guchar **buffer);
00571
00581 gssize purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size);
00582
00601 void purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip,
00602 unsigned int port);
00603
00609 void purple_xfer_end(PurpleXfer *xfer);
00610
00617 void purple_xfer_add(PurpleXfer *xfer);
00618
00624 void purple_xfer_cancel_local(PurpleXfer *xfer);
00625
00631 void purple_xfer_cancel_remote(PurpleXfer *xfer);
00632
00645 void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg);
00646
00652 void purple_xfer_update_progress(PurpleXfer *xfer);
00653
00663 void purple_xfer_conversation_write(PurpleXfer *xfer, char *message, gboolean is_error);
00664
00674 void purple_xfer_ui_ready(PurpleXfer *xfer);
00675
00685 void purple_xfer_prpl_ready(PurpleXfer *xfer);
00686
00689
00691
00699 void *purple_xfers_get_handle(void);
00700
00704 void purple_xfers_init(void);
00705
00709 void purple_xfers_uninit(void);
00710
00716 void purple_xfers_set_ui_ops(PurpleXferUiOps *ops);
00717
00723 PurpleXferUiOps *purple_xfers_get_ui_ops(void);
00724
00727 #ifdef __cplusplus
00728 }
00729 #endif
00730
00731 #endif