_PurpleXfer Struct Reference

A core representation of a file transfer. More...

#include <ft.h>

Collaboration diagram for _PurpleXfer:
Collaboration graph

Data Fields

guint ref
 The reference count.
PurpleXferType type
 The type of transfer.
PurpleAccountaccount
 The account.
char * who
 The person on the other end of the transfer.
char * message
 A message sent with the request.
char * filename
 The name sent over the network.
char * local_filename
 The name on the local hard drive.
size_t size
 The size of the file.
FILE * dest_fp
 The destination file pointer.
char * remote_ip
 The remote IP address.
int local_port
 The local port.
int remote_port
 The remote port.
int fd
 The socket file descriptor.
int watcher
 Watcher.
size_t bytes_sent
 The number of bytes sent.
size_t bytes_remaining
 The number of bytes remaining.
time_t start_time
 When the transfer of data began.
time_t end_time
 When the transfer of data ended.
size_t current_buffer_size
 This gradually increases for fast network connections.
PurpleXferStatusType status
 File Transfer's 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
 I/O operations, which should be set by the prpl using purple_xfer_set_init_fnc() and friends.
PurpleXferUiOpsui_ops
 UI-specific operations.
void * ui_data
 UI-specific data.
void * data
 prpl-specific data.

Detailed Description

A core representation of a file transfer.

Definition at line 134 of file ft.h.

Field Documentation

PurpleAccount* _PurpleXfer::account

The account.

Definition at line 139 of file ft.h.

size_t _PurpleXfer::bytes_remaining

The number of bytes remaining.

Definition at line 159 of file ft.h.

size_t _PurpleXfer::bytes_sent

The number of bytes sent.

Definition at line 158 of file ft.h.

size_t _PurpleXfer::current_buffer_size

This gradually increases for fast network connections.

Definition at line 163 of file ft.h.

void* _PurpleXfer::data

prpl-specific data.

Definition at line 188 of file ft.h.

FILE* _PurpleXfer::dest_fp

The destination file pointer.

Definition at line 149 of file ft.h.

time_t _PurpleXfer::end_time

When the transfer of data ended.

Definition at line 161 of file ft.h.

int _PurpleXfer::fd

The socket file descriptor.

Definition at line 155 of file ft.h.

char* _PurpleXfer::filename

The name sent over the network.

Definition at line 145 of file ft.h.

char* _PurpleXfer::local_filename

The name on the local hard drive.

Definition at line 146 of file ft.h.

int _PurpleXfer::local_port

The local port.

Definition at line 152 of file ft.h.

struct { ... } _PurpleXfer::ops

I/O operations, which should be set by the prpl using purple_xfer_set_init_fnc() and friends.

Setting #init is mandatory; all others are optional.

guint _PurpleXfer::ref

The reference count.

Definition at line 136 of file ft.h.

char* _PurpleXfer::remote_ip

The remote IP address.

Definition at line 151 of file ft.h.

int _PurpleXfer::remote_port

The remote port.

Definition at line 153 of file ft.h.

size_t _PurpleXfer::size

The size of the file.

Definition at line 147 of file ft.h.

time_t _PurpleXfer::start_time

When the transfer of data began.

Definition at line 160 of file ft.h.

PurpleXferStatusType _PurpleXfer::status

File Transfer's status.

Definition at line 166 of file ft.h.

PurpleXferType _PurpleXfer::type

The type of transfer.

Definition at line 137 of file ft.h.

void* _PurpleXfer::ui_data

UI-specific data.

Definition at line 186 of file ft.h.

PurpleXferUiOps* _PurpleXfer::ui_ops

UI-specific operations.

Definition at line 185 of file ft.h.

int _PurpleXfer::watcher

Watcher.

Definition at line 156 of file ft.h.

char* _PurpleXfer::who

The person on the other end of the transfer.

Definition at line 141 of file ft.h.


The documentation for this struct was generated from the following file:
All information, including names and email addresses, entered onto this website or sent to mailing lists affiliated with this website will be public. Do not post confidential information, especially passwords!