ft.h

Go to the documentation of this file.

 
/* purple
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */
#ifndef _PURPLE_FT_H_
#define _PURPLE_FT_H_
 
/**************************************************************************/
/**************************************************************************/
typedef struct _PurpleXfer PurpleXfer;
 
#include <glib.h>
#include <stdio.h>
 
#include "account.h"
 
typedef enum
{
    PURPLE_XFER_UNKNOWN = 0,  
    PURPLE_XFER_SEND,         
    PURPLE_XFER_RECEIVE       
} PurpleXferType;
 
typedef enum
{
    PURPLE_XFER_STATUS_UNKNOWN = 0,   
    PURPLE_XFER_STATUS_NOT_STARTED,   
    PURPLE_XFER_STATUS_ACCEPTED,      
    PURPLE_XFER_STATUS_STARTED,       
    PURPLE_XFER_STATUS_DONE,          
    PURPLE_XFER_STATUS_CANCEL_LOCAL,  
    PURPLE_XFER_STATUS_CANCEL_REMOTE  
} PurpleXferStatusType;
 
typedef struct
{
    void (*new_xfer)(PurpleXfer *xfer);
    void (*destroy)(PurpleXfer *xfer);
    void (*add_xfer)(PurpleXfer *xfer);
    void (*update_progress)(PurpleXfer *xfer, double percent);
    void (*cancel_local)(PurpleXfer *xfer);
    void (*cancel_remote)(PurpleXfer *xfer);
 
    gssize (*ui_write)(PurpleXfer *xfer, const guchar *buffer, gssize size);
 
    gssize (*ui_read)(PurpleXfer *xfer, guchar **buffer, gssize size);
 
    void (*data_not_sent)(PurpleXfer *xfer, const guchar *buffer, gsize size);
 
    void (*add_thumbnail)(PurpleXfer *xfer, const gchar *formats);
} PurpleXferUiOps;
 
struct _PurpleXfer
{
    guint ref;                    
    PurpleXferType type;            
    PurpleAccount *account;         
    char *who;                    
    char *message;                
    char *filename;               
    char *local_filename;         
    size_t size;                  
    FILE *dest_fp;                
    char *remote_ip;              
    int local_port;               
    int remote_port;              
    int fd;                       
    int watcher;                  
    size_t bytes_sent;            
    size_t bytes_remaining;       
    time_t start_time;            
    time_t end_time;              
    size_t current_buffer_size;   
    PurpleXferStatusType status;    
    struct
    {
        void (*init)(PurpleXfer *xfer);
        void (*request_denied)(PurpleXfer *xfer);
        void (*start)(PurpleXfer *xfer);
        void (*end)(PurpleXfer *xfer);
        void (*cancel_send)(PurpleXfer *xfer);
        void (*cancel_recv)(PurpleXfer *xfer);
        gssize (*read)(guchar **buffer, PurpleXfer *xfer);
        gssize (*write)(const guchar *buffer, size_t size, PurpleXfer *xfer);
        void (*ack)(PurpleXfer *xfer, const guchar *buffer, size_t size);
    } ops;
 
    PurpleXferUiOps *ui_ops;            
    void *ui_data;                    
    void *data;                       
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************************/
/**************************************************************************/
PurpleXfer *purple_xfer_new(PurpleAccount *account,
                                PurpleXferType type, const char *who);
 
GList *purple_xfers_get_all(void);
 
void purple_xfer_ref(PurpleXfer *xfer);
 
void purple_xfer_unref(PurpleXfer *xfer);
 
void purple_xfer_request(PurpleXfer *xfer);
 
void purple_xfer_request_accepted(PurpleXfer *xfer, const char *filename);
 
void purple_xfer_request_denied(PurpleXfer *xfer);
 
PurpleXferType purple_xfer_get_type(const PurpleXfer *xfer);
 
PurpleAccount *purple_xfer_get_account(const PurpleXfer *xfer);
 
const char *purple_xfer_get_remote_user(const PurpleXfer *xfer);
 
PurpleXferStatusType purple_xfer_get_status(const PurpleXfer *xfer);
 
gboolean purple_xfer_is_canceled(const PurpleXfer *xfer);
 
gboolean purple_xfer_is_completed(const PurpleXfer *xfer);
 
const char *purple_xfer_get_filename(const PurpleXfer *xfer);
 
const char *purple_xfer_get_local_filename(const PurpleXfer *xfer);
 
size_t purple_xfer_get_bytes_sent(const PurpleXfer *xfer);
 
size_t purple_xfer_get_bytes_remaining(const PurpleXfer *xfer);
 
size_t purple_xfer_get_size(const PurpleXfer *xfer);
 
double purple_xfer_get_progress(const PurpleXfer *xfer);
 
unsigned int purple_xfer_get_local_port(const PurpleXfer *xfer);
 
const char *purple_xfer_get_remote_ip(const PurpleXfer *xfer);
 
unsigned int purple_xfer_get_remote_port(const PurpleXfer *xfer);
 
time_t purple_xfer_get_start_time(const PurpleXfer *xfer);
 
time_t purple_xfer_get_end_time(const PurpleXfer *xfer);
 
void purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed);
 
void purple_xfer_set_message(PurpleXfer *xfer, const char *message);
 
void purple_xfer_set_filename(PurpleXfer *xfer, const char *filename);
 
void purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename);
 
void purple_xfer_set_size(PurpleXfer *xfer, size_t size);
 
void purple_xfer_set_bytes_sent(PurpleXfer *xfer, size_t bytes_sent);
 
PurpleXferUiOps *purple_xfer_get_ui_ops(const PurpleXfer *xfer);
 
void purple_xfer_set_read_fnc(PurpleXfer *xfer,
        gssize (*fnc)(guchar **, PurpleXfer *));
 
void purple_xfer_set_write_fnc(PurpleXfer *xfer,
        gssize (*fnc)(const guchar *, size_t, PurpleXfer *));
 
void purple_xfer_set_ack_fnc(PurpleXfer *xfer,
        void (*fnc)(PurpleXfer *, const guchar *, size_t));
 
void purple_xfer_set_request_denied_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
 
void purple_xfer_set_init_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
 
void purple_xfer_set_start_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
 
void purple_xfer_set_end_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
 
void purple_xfer_set_cancel_send_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
 
void purple_xfer_set_cancel_recv_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
 
gssize purple_xfer_read(PurpleXfer *xfer, guchar **buffer);
 
gssize purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size);
 
gboolean
purple_xfer_write_file(PurpleXfer *xfer, const guchar *buffer, gsize size);
 
gssize
purple_xfer_read_file(PurpleXfer *xfer, guchar *buffer, gsize size);
 
void purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip,
                     unsigned int port);
 
void purple_xfer_end(PurpleXfer *xfer);
 
void purple_xfer_add(PurpleXfer *xfer);
 
void purple_xfer_cancel_local(PurpleXfer *xfer);
 
void purple_xfer_cancel_remote(PurpleXfer *xfer);
 
void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg);
 
void purple_xfer_update_progress(PurpleXfer *xfer);
 
void purple_xfer_conversation_write(PurpleXfer *xfer, char *message, gboolean is_error);
 
void purple_xfer_ui_ready(PurpleXfer *xfer);
 
void purple_xfer_prpl_ready(PurpleXfer *xfer);
 
gconstpointer purple_xfer_get_thumbnail(const PurpleXfer *xfer, gsize *len);
 
const gchar *purple_xfer_get_thumbnail_mimetype(const PurpleXfer *xfer);
 
 
void purple_xfer_set_thumbnail(PurpleXfer *xfer, gconstpointer thumbnail,
    gsize size, const gchar *mimetype);
 
void purple_xfer_prepare_thumbnail(PurpleXfer *xfer, const gchar *formats);
 
 
/**************************************************************************/
/**************************************************************************/
void *purple_xfers_get_handle(void);
 
void purple_xfers_init(void);
 
void purple_xfers_uninit(void);
 
void purple_xfers_set_ui_ops(PurpleXferUiOps *ops);
 
PurpleXferUiOps *purple_xfers_get_ui_ops(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_FT_H_ */