ft.h

Go to the documentation of this file.
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 
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 
00248 const char *purple_xfer_get_remote_user(const PurpleXfer *xfer);
00249 
00257 PurpleXferStatusType purple_xfer_get_status(const PurpleXfer *xfer);
00258 
00266 gboolean purple_xfer_is_canceled(const PurpleXfer *xfer);
00267 
00275 gboolean purple_xfer_is_completed(const PurpleXfer *xfer);
00276 
00284 const char *purple_xfer_get_filename(const PurpleXfer *xfer);
00285 
00293 const char *purple_xfer_get_local_filename(const PurpleXfer *xfer);
00294 
00302 size_t purple_xfer_get_bytes_sent(const PurpleXfer *xfer);
00303 
00311 size_t purple_xfer_get_bytes_remaining(const PurpleXfer *xfer);
00312 
00320 size_t purple_xfer_get_size(const PurpleXfer *xfer);
00321 
00331 double purple_xfer_get_progress(const PurpleXfer *xfer);
00332 
00340 unsigned int purple_xfer_get_local_port(const PurpleXfer *xfer);
00341 
00349 const char *purple_xfer_get_remote_ip(const PurpleXfer *xfer);
00350 
00358 unsigned int purple_xfer_get_remote_port(const PurpleXfer *xfer);
00359 
00368 time_t purple_xfer_get_start_time(const PurpleXfer *xfer);
00369 
00378 time_t purple_xfer_get_end_time(const PurpleXfer *xfer);
00379 
00386 void purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed);
00387 
00394 void purple_xfer_set_message(PurpleXfer *xfer, const char *message);
00395 
00402 void purple_xfer_set_filename(PurpleXfer *xfer, const char *filename);
00403 
00410 void purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename);
00411 
00418 void purple_xfer_set_size(PurpleXfer *xfer, size_t size);
00419 
00433 void purple_xfer_set_bytes_sent(PurpleXfer *xfer, size_t bytes_sent);
00434 
00442 PurpleXferUiOps *purple_xfer_get_ui_ops(const PurpleXfer *xfer);
00443 
00450 void purple_xfer_set_read_fnc(PurpleXfer *xfer,
00451         gssize (*fnc)(guchar **, PurpleXfer *));
00452 
00459 void purple_xfer_set_write_fnc(PurpleXfer *xfer,
00460         gssize (*fnc)(const guchar *, size_t, PurpleXfer *));
00461 
00468 void purple_xfer_set_ack_fnc(PurpleXfer *xfer,
00469         void (*fnc)(PurpleXfer *, const guchar *, size_t));
00470 
00477 void purple_xfer_set_request_denied_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00478 
00489 void purple_xfer_set_init_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00490 
00497 void purple_xfer_set_start_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00498 
00505 void purple_xfer_set_end_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00506 
00513 void purple_xfer_set_cancel_send_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00514 
00521 void purple_xfer_set_cancel_recv_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
00522 
00531 gssize purple_xfer_read(PurpleXfer *xfer, guchar **buffer);
00532 
00542 gssize purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size);
00543 
00556 void purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip,
00557                      unsigned int port);
00558 
00564 void purple_xfer_end(PurpleXfer *xfer);
00565 
00572 void purple_xfer_add(PurpleXfer *xfer);
00573 
00579 void purple_xfer_cancel_local(PurpleXfer *xfer);
00580 
00586 void purple_xfer_cancel_remote(PurpleXfer *xfer);
00587 
00600 void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg);
00601 
00607 void purple_xfer_update_progress(PurpleXfer *xfer);
00608 
00618 void purple_xfer_conversation_write(PurpleXfer *xfer, char *message, gboolean is_error);
00619 
00622 /**************************************************************************/
00624 /**************************************************************************/
00632 void *purple_xfers_get_handle(void);
00633 
00637 void purple_xfers_init(void);
00638 
00642 void purple_xfers_uninit(void);
00643 
00649 void purple_xfers_set_ui_ops(PurpleXferUiOps *ops);
00650 
00656 PurpleXferUiOps *purple_xfers_get_ui_ops(void);
00657 
00660 #ifdef __cplusplus
00661 }
00662 #endif
00663 
00664 #endif /* _PURPLE_FT_H_ */