ft.h

Go to the documentation of this file.
00001 
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 
00080     void (*_purple_reserved1)(void);
00081     void (*_purple_reserved2)(void);
00082     void (*_purple_reserved3)(void);
00083     void (*_purple_reserved4)(void);
00084 } PurpleXferUiOps;
00085 
00089 struct _PurpleXfer
00090 {
00091     guint ref;                    
00092     PurpleXferType type;            
00094     PurpleAccount *account;         
00096     char *who;                    
00099     char *message;                
00100     char *filename;               
00101     char *local_filename;         
00102     size_t size;                  
00104     FILE *dest_fp;                
00106     char *remote_ip;              
00107     int local_port;               
00108     int remote_port;              
00110     int fd;                       
00111     int watcher;                  
00113     size_t bytes_sent;            
00114     size_t bytes_remaining;       
00115     time_t start_time;            
00116     time_t end_time;              
00118     size_t current_buffer_size;   
00121     PurpleXferStatusType status;    
00123     /* I/O operations. */
00124     struct
00125     {
00126         void (*init)(PurpleXfer *xfer);
00127         void (*request_denied)(PurpleXfer *xfer);
00128         void (*start)(PurpleXfer *xfer);
00129         void (*end)(PurpleXfer *xfer);
00130         void (*cancel_send)(PurpleXfer *xfer);
00131         void (*cancel_recv)(PurpleXfer *xfer);
00132         gssize (*read)(guchar **buffer, PurpleXfer *xfer);
00133         gssize (*write)(const guchar *buffer, size_t size, PurpleXfer *xfer);
00134         void (*ack)(PurpleXfer *xfer, const guchar *buffer, size_t size);
00135 
00136     } ops;
00137 
00138     PurpleXferUiOps *ui_ops;            
00139     void *ui_data;                    
00141     void *data;                       
00142 };
00143 
00144 #ifdef __cplusplus
00145 extern "C" {
00146 #endif
00147 
00148 /**************************************************************************/
00150 /**************************************************************************/
00166 PurpleXfer *purple_xfer_new(PurpleAccount *account,
00167                                 PurpleXferType type, const char *who);
00168 
00174 GList *purple_xfers_get_all(void);
00175 
00182 void purple_xfer_ref(PurpleXfer *xfer);
00183 
00193 void purple_xfer_unref(PurpleXfer *xfer);
00194 
00204 void purple_xfer_request(PurpleXfer *xfer);
00205 
00212 void purple_xfer_request_accepted(PurpleXfer *xfer, const char *filename);
00213 
00219 void purple_xfer_request_denied(PurpleXfer *xfer);
00220 
00228 PurpleXferType purple_xfer_get_type(const PurpleXfer *xfer);
00229 
00237 PurpleAccount *purple_xfer_get_account(const PurpleXfer *xfer);
00238 
00246 const char *purple_xfer_get_remote_user(const PurpleXfer *xfer);
00247 
00255 PurpleXferStatusType purple_xfer_get_status(const PurpleXfer *xfer);
00256 
00264 gboolean purple_xfer_is_canceled(const PurpleXfer *xfer);
00265 
00273 gboolean purple_xfer_is_completed(const PurpleXfer *xfer);
00274 
00282 const char *purple_xfer_get_filename(const PurpleXfer *xfer);
00283 
00291 const char *purple_xfer_get_local_filename(const PurpleXfer *xfer);
00292 
00300 size_t purple_xfer_get_bytes_sent(const PurpleXfer *xfer);
00301 
00309 size_t purple_xfer_get_bytes_remaining(const PurpleXfer *xfer);
00310 
00318 size_t purple_xfer_get_size(const PurpleXfer *xfer);
00319 
00329 double purple_xfer_get_progress(const PurpleXfer *xfer);
00330 
00338 unsigned int purple_xfer_get_local_port(const PurpleXfer *xfer);
00339 
00347 const char *purple_xfer_get_remote_ip(const PurpleXfer *xfer);
00348 
00356 unsigned int purple_xfer_get_remote_port(const PurpleXfer *xfer);
00357 
00364 void purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed);
00365 
00372 void purple_xfer_set_message(PurpleXfer *xfer, const char *message);
00373 
00380 void purple_xfer_set_filename(PurpleXfer *xfer, const char *filename);
00381 
00388 void purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename);
00389 
00396 void purple_xfer_set_size(PurpleXfer *xfer, size_t size);
00397 
00411 void purple_xfer_set_bytes_sent(PurpleXfer *xfer, size_t bytes_sent);
00412 
00420 PurpleXferUiOps *purple_xfer_get_ui_ops(const PurpleXfer *xfer);
00421 
00428 void purple_xfer_set_read_fnc(PurpleXfer *xfer,
00429         gssize (*fnc)(guchar **, PurpleXfer *));
00430 
00437 void purple_xfer_set_write_fnc(PurpleXfer *xfer,
00438         gssize (*fnc)(const guchar *, size_t, PurpleXfer *));
00439 
00446 void purple_xfer_set_ack_fnc(PurpleXfer *xfer,
00447         void (*fnc)(PurpleXfer *, const guchar *, size_t));
00448 
00455 void purple_xfer_set_request_denied_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00456 
00467 void purple_xfer_set_init_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00468 
00475 void purple_xfer_set_start_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00476 
00483 void purple_xfer_set_end_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00484 
00491 void purple_xfer_set_cancel_send_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00492 
00499 void purple_xfer_set_cancel_recv_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00500 
00509 gssize purple_xfer_read(PurpleXfer *xfer, guchar **buffer);
00510 
00520 gssize purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size);
00521 
00534 void purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip,
00535                      unsigned int port);
00536 
00542 void purple_xfer_end(PurpleXfer *xfer);
00543 
00550 void purple_xfer_add(PurpleXfer *xfer);
00551 
00557 void purple_xfer_cancel_local(PurpleXfer *xfer);
00558 
00564 void purple_xfer_cancel_remote(PurpleXfer *xfer);
00565 
00578 void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg);
00579 
00585 void purple_xfer_update_progress(PurpleXfer *xfer);
00586 
00596 void purple_xfer_conversation_write(PurpleXfer *xfer, char *message, gboolean is_error);
00597 
00600 /**************************************************************************/
00602 /**************************************************************************/
00610 void *purple_xfers_get_handle(void);
00611 
00615 void purple_xfers_init(void);
00616 
00620 void purple_xfers_uninit(void);
00621 
00627 void purple_xfers_set_ui_ops(PurpleXferUiOps *ops);
00628 
00634 PurpleXferUiOps *purple_xfers_get_ui_ops(void);
00635 
00638 #ifdef __cplusplus
00639 }
00640 #endif
00641 
00642 #endif /* _PURPLE_FT_H_ */