ft.h

00001
00007 /* purple
00008  *
00009  * Purple is the legal property of its developers, whose names are too numerous
00010  * to list here.  Please refer to the COPYRIGHT file distributed with this
00011  * source distribution.
00012  *
00013  * This program is free software; you can redistribute it and/or modify
00014  * it under the terms of the GNU General Public License as published by
00015  * the Free Software Foundation; either version 2 of the License, or
00016  * (at your option) any later version.
00017  *
00018  * This program is distributed in the hope that it will be useful,
00019  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00021  * GNU General Public License for more details.
00022  *
00023  * You should have received a copy of the GNU General Public License
00024  * along with this program; if not, write to the Free Software
00025  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
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;
00167     struct
00168     {
00169         void (*init)(PurpleXfer *xfer);
00170         void (*request_denied)(PurpleXfer *xfer);
00171         void (*start)(PurpleXfer *xfer);
00172         void (*end)(PurpleXfer *xfer);
00173         void (*cancel_send)(PurpleXfer *xfer);
00174         void (*cancel_recv)(PurpleXfer *xfer);
00175         gssize (*read)(guchar **buffer, PurpleXfer *xfer);
00176         gssize (*write)(const guchar *buffer, size_t size, PurpleXfer *xfer);
00177         void (*ack)(PurpleXfer *xfer, const guchar *buffer, size_t size);
00178     } ops;
00179
00180     PurpleXferUiOps *ui_ops;
00181     void *ui_data;
00183     void *data;
00184 };
00185
00186 #ifdef __cplusplus
00187 extern "C" {
00188 #endif
00189 
00190 /**************************************************************************/
00192 /**************************************************************************/
00208 PurpleXfer *purple_xfer_new(PurpleAccount *account,
00209                                 PurpleXferType type, const char *who);
00210
00216 GList *purple_xfers_get_all(void);
00217
00224 void purple_xfer_ref(PurpleXfer *xfer);
00225
00235 void purple_xfer_unref(PurpleXfer *xfer);
00236
00246 void purple_xfer_request(PurpleXfer *xfer);
00247
00254 void purple_xfer_request_accepted(PurpleXfer *xfer, const char *filename);
00255
00261 void purple_xfer_request_denied(PurpleXfer *xfer);
00262
00270 PurpleXferType purple_xfer_get_type(const PurpleXfer *xfer);
00271
00279 PurpleAccount *purple_xfer_get_account(const PurpleXfer *xfer);
00280
00290 const char *purple_xfer_get_remote_user(const PurpleXfer *xfer);
00291
00299 PurpleXferStatusType purple_xfer_get_status(const PurpleXfer *xfer);
00300
00308 gboolean purple_xfer_is_canceled(const PurpleXfer *xfer);
00309
00317 gboolean purple_xfer_is_completed(const PurpleXfer *xfer);
00318
00326 const char *purple_xfer_get_filename(const PurpleXfer *xfer);
00327
00335 const char *purple_xfer_get_local_filename(const PurpleXfer *xfer);
00336
00344 size_t purple_xfer_get_bytes_sent(const PurpleXfer *xfer);
00345
00353 size_t purple_xfer_get_bytes_remaining(const PurpleXfer *xfer);
00354
00362 size_t purple_xfer_get_size(const PurpleXfer *xfer);
00363
00373 double purple_xfer_get_progress(const PurpleXfer *xfer);
00374
00382 unsigned int purple_xfer_get_local_port(const PurpleXfer *xfer);
00383
00391 const char *purple_xfer_get_remote_ip(const PurpleXfer *xfer);
00392
00400 unsigned int purple_xfer_get_remote_port(const PurpleXfer *xfer);
00401
00410 time_t purple_xfer_get_start_time(const PurpleXfer *xfer);
00411
00420 time_t purple_xfer_get_end_time(const PurpleXfer *xfer);
00421
00428 void purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed);
00429
00436 void purple_xfer_set_message(PurpleXfer *xfer, const char *message);
00437
00444 void purple_xfer_set_filename(PurpleXfer *xfer, const char *filename);
00445
00452 void purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename);
00453
00460 void purple_xfer_set_size(PurpleXfer *xfer, size_t size);
00461
00475 void purple_xfer_set_bytes_sent(PurpleXfer *xfer, size_t bytes_sent);
00476
00484 PurpleXferUiOps *purple_xfer_get_ui_ops(const PurpleXfer *xfer);
00485
00492 void purple_xfer_set_read_fnc(PurpleXfer *xfer,
00493         gssize (*fnc)(guchar **, PurpleXfer *));
00494
00501 void purple_xfer_set_write_fnc(PurpleXfer *xfer,
00502         gssize (*fnc)(const guchar *, size_t, PurpleXfer *));
00503
00510 void purple_xfer_set_ack_fnc(PurpleXfer *xfer,
00511         void (*fnc)(PurpleXfer *, const guchar *, size_t));
00512
00519 void purple_xfer_set_request_denied_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00520
00531 void purple_xfer_set_init_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00532
00539 void purple_xfer_set_start_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00540
00547 void purple_xfer_set_end_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00548
00555 void purple_xfer_set_cancel_send_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00556
00563 void purple_xfer_set_cancel_recv_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00564
00573 gssize purple_xfer_read(PurpleXfer *xfer, guchar **buffer);
00574
00584 gssize purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size);
00585
00604 void purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip,
00605                      unsigned int port);
00606
00612 void purple_xfer_end(PurpleXfer *xfer);
00613
00620 void purple_xfer_add(PurpleXfer *xfer);
00621
00627 void purple_xfer_cancel_local(PurpleXfer *xfer);
00628
00634 void purple_xfer_cancel_remote(PurpleXfer *xfer);
00635
00648 void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg);
00649
00655 void purple_xfer_update_progress(PurpleXfer *xfer);
00656
00666 void purple_xfer_conversation_write(PurpleXfer *xfer, char *message, gboolean is_error);
00667
00677 void purple_xfer_ui_ready(PurpleXfer *xfer);
00678
00688 void purple_xfer_prpl_ready(PurpleXfer *xfer);
00689
00692 /**************************************************************************/
00694 /**************************************************************************/
00702 void *purple_xfers_get_handle(void);
00703
00707 void purple_xfers_init(void);
00708
00712 void purple_xfers_uninit(void);
00713
00719 void purple_xfers_set_ui_ops(PurpleXferUiOps *ops);
00720
00726 PurpleXferUiOps *purple_xfers_get_ui_ops(void);
00727
00730 #ifdef __cplusplus
00731 }
00732 #endif
00733 
00734 #endif /* _PURPLE_FT_H_ */