pidgin  2.14.10
ft.h
Go to the documentation of this file.
1 
7 /* purple
8  *
9  * Purple is the legal property of its developers, whose names are too numerous
10  * to list here. Please refer to the COPYRIGHT file distributed with this
11  * source distribution.
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
26  */
27 #ifndef _PURPLE_FT_H_
28 #define _PURPLE_FT_H_
29 
30 /**************************************************************************/
32 /**************************************************************************/
33 typedef struct _PurpleXfer PurpleXfer;
34 
35 #include <glib.h>
36 #include <stdio.h>
37 
38 #include "account.h"
39 
43 typedef enum
44 {
50 
54 typedef enum
55 {
64 
71 typedef struct
72 {
73  void (*new_xfer)(PurpleXfer *xfer);
74  void (*destroy)(PurpleXfer *xfer);
75  void (*add_xfer)(PurpleXfer *xfer);
76  void (*update_progress)(PurpleXfer *xfer, double percent);
77  void (*cancel_local)(PurpleXfer *xfer);
78  void (*cancel_remote)(PurpleXfer *xfer);
79 
92  gssize (*ui_write)(PurpleXfer *xfer, const guchar *buffer, gssize size);
93 
107  gssize (*ui_read)(PurpleXfer *xfer, guchar **buffer, gssize size);
108 
121  void (*data_not_sent)(PurpleXfer *xfer, const guchar *buffer, gsize size);
122 
128  void (*add_thumbnail)(PurpleXfer *xfer, const gchar *formats);
130 
135 {
136  guint ref;
141  char *who;
144  char *message;
145  char *filename;
147  size_t size;
149  FILE *dest_fp;
151  char *remote_ip;
155  int fd;
156  int watcher;
158  size_t bytes_sent;
160  time_t start_time;
161  time_t end_time;
172  struct
173  {
174  void (*init)(PurpleXfer *xfer);
175  void (*request_denied)(PurpleXfer *xfer);
176  void (*start)(PurpleXfer *xfer);
177  void (*end)(PurpleXfer *xfer);
178  void (*cancel_send)(PurpleXfer *xfer);
179  void (*cancel_recv)(PurpleXfer *xfer);
180  gssize (*read)(guchar **buffer, PurpleXfer *xfer);
181  gssize (*write)(const guchar *buffer, size_t size, PurpleXfer *xfer);
182  void (*ack)(PurpleXfer *xfer, const guchar *buffer, size_t size);
183  } ops;
184 
186  void *ui_data;
188  void *data;
189 };
190 
191 #ifdef __cplusplus
192 extern "C" {
193 #endif
194 
195 /**************************************************************************/
197 /**************************************************************************/
214  PurpleXferType type, const char *who);
215 
221 GList *purple_xfers_get_all(void);
222 
230 
241 
252 
259 void purple_xfer_request_accepted(PurpleXfer *xfer, const char *filename);
260 
267 
276 
285 
295 const char *purple_xfer_get_remote_user(const PurpleXfer *xfer);
296 
305 
314 gboolean purple_xfer_is_canceled(const PurpleXfer *xfer);
315 
323 gboolean purple_xfer_is_completed(const PurpleXfer *xfer);
324 
332 const char *purple_xfer_get_filename(const PurpleXfer *xfer);
333 
342 
351 
360 
368 size_t purple_xfer_get_size(const PurpleXfer *xfer);
369 
380 
388 unsigned int purple_xfer_get_local_port(const PurpleXfer *xfer);
389 
397 const char *purple_xfer_get_remote_ip(const PurpleXfer *xfer);
398 
406 unsigned int purple_xfer_get_remote_port(const PurpleXfer *xfer);
407 
417 
427 
434 void purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed);
435 
442 void purple_xfer_set_message(PurpleXfer *xfer, const char *message);
443 
450 void purple_xfer_set_filename(PurpleXfer *xfer, const char *filename);
451 
458 void purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename);
459 
466 void purple_xfer_set_size(PurpleXfer *xfer, size_t size);
467 
481 void purple_xfer_set_bytes_sent(PurpleXfer *xfer, size_t bytes_sent);
482 
491 
499  gssize (*fnc)(guchar **, PurpleXfer *));
500 
508  gssize (*fnc)(const guchar *, size_t, PurpleXfer *));
509 
517  void (*fnc)(PurpleXfer *, const guchar *, size_t));
518 
526 
537 void purple_xfer_set_init_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
538 
545 void purple_xfer_set_start_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
546 
553 void purple_xfer_set_end_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
554 
562 
570 
579 gssize purple_xfer_read(PurpleXfer *xfer, guchar **buffer);
580 
590 gssize purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size);
591 
603 gboolean
604 purple_xfer_write_file(PurpleXfer *xfer, const guchar *buffer, gsize size);
605 
618 gssize
619 purple_xfer_read_file(PurpleXfer *xfer, guchar *buffer, gsize size);
620 
639 void purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip,
640  unsigned int port);
641 
648 
656 
663 
670 
683 void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg);
684 
691 
701 void purple_xfer_conversation_write(PurpleXfer *xfer, char *message, gboolean is_error);
702 
713 
724 
734 gconstpointer purple_xfer_get_thumbnail(const PurpleXfer *xfer, gsize *len);
735 
744 
745 
755 void purple_xfer_set_thumbnail(PurpleXfer *xfer, gconstpointer thumbnail,
756  gsize size, const gchar *mimetype);
757 
767 void purple_xfer_prepare_thumbnail(PurpleXfer *xfer, const gchar *formats);
768 
769 
772 /**************************************************************************/
774 /**************************************************************************/
783 
787 void purple_xfers_init(void);
788 
793 
800 
807 
810 #ifdef __cplusplus
811 }
812 #endif
813 
814 #endif /* _PURPLE_FT_H_ */
Account API.
const gchar * purple_xfer_get_thumbnail_mimetype(const PurpleXfer *xfer)
Gets the mimetype of the thumbnail preview for a transfer.
void purple_xfers_init(void)
Initializes the file transfer subsystem.
void purple_xfer_conversation_write(PurpleXfer *xfer, char *message, gboolean is_error)
Displays a file transfer-related message in the conversation window.
void purple_xfer_prepare_thumbnail(PurpleXfer *xfer, const gchar *formats)
Prepare a thumbnail for a transfer (if the UI supports it) will be no-op in case the UI doesn't imple...
unsigned int purple_xfer_get_local_port(const PurpleXfer *xfer)
Returns the local port number in the file transfer.
gssize purple_xfer_read_file(PurpleXfer *xfer, guchar *buffer, gsize size)
Writes chunk of file being sent.
void purple_xfers_uninit(void)
Uninitializes the file transfer subsystem.
void purple_xfer_set_end_fnc(PurpleXfer *xfer, void(*fnc)(PurpleXfer *))
Sets the end transfer function for the file transfer.
void purple_xfer_set_ack_fnc(PurpleXfer *xfer, void(*fnc)(PurpleXfer *, const guchar *, size_t))
Sets the acknowledge function for the file transfer.
PurpleXferStatusType
The different states of the xfer.
Definition: ft.h:55
@ PURPLE_XFER_STATUS_STARTED
purple_xfer_start has been called.
Definition: ft.h:59
@ PURPLE_XFER_STATUS_NOT_STARTED
It hasn't started yet.
Definition: ft.h:57
@ PURPLE_XFER_STATUS_UNKNOWN
Unknown, the xfer may be null.
Definition: ft.h:56
@ PURPLE_XFER_STATUS_CANCEL_REMOTE
The xfer was cancelled by the other end, or we couldn't connect.
Definition: ft.h:62
@ PURPLE_XFER_STATUS_DONE
The xfer completed successfully.
Definition: ft.h:60
@ PURPLE_XFER_STATUS_ACCEPTED
Receive accepted, but destination file not selected yet.
Definition: ft.h:58
@ PURPLE_XFER_STATUS_CANCEL_LOCAL
The xfer was cancelled by us.
Definition: ft.h:61
size_t purple_xfer_get_size(const PurpleXfer *xfer)
Returns the size of the file being sent or received.
void purple_xfer_set_init_fnc(PurpleXfer *xfer, void(*fnc)(PurpleXfer *))
Sets the transfer initialization function for the file transfer.
void purple_xfer_request(PurpleXfer *xfer)
Requests confirmation for a file transfer from the user.
gssize purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size)
Writes data to a file transfer stream.
PurpleXferType purple_xfer_get_type(const PurpleXfer *xfer)
Returns the type of file transfer.
size_t purple_xfer_get_bytes_sent(const PurpleXfer *xfer)
Returns the number of bytes sent (or received) so far.
size_t purple_xfer_get_bytes_remaining(const PurpleXfer *xfer)
Returns the number of bytes remaining to send or receive.
GList * purple_xfers_get_all(void)
Returns all xfers.
unsigned int purple_xfer_get_remote_port(const PurpleXfer *xfer)
Returns the remote port number in the file transfer.
void purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed)
Sets the completed state for the file transfer.
gconstpointer purple_xfer_get_thumbnail(const PurpleXfer *xfer, gsize *len)
Gets the thumbnail data for a transfer.
PurpleXferStatusType purple_xfer_get_status(const PurpleXfer *xfer)
Returns the status of the xfer.
void purple_xfer_set_write_fnc(PurpleXfer *xfer, gssize(*fnc)(const guchar *, size_t, PurpleXfer *))
Sets the write function for the file transfer.
PurpleXferType
Types of file transfers.
Definition: ft.h:44
@ PURPLE_XFER_UNKNOWN
Unknown file transfer type.
Definition: ft.h:45
@ PURPLE_XFER_RECEIVE
File receiving.
Definition: ft.h:47
@ PURPLE_XFER_SEND
File sending.
Definition: ft.h:46
void purple_xfer_set_cancel_send_fnc(PurpleXfer *xfer, void(*fnc)(PurpleXfer *))
Sets the cancel send function for the file transfer.
void purple_xfer_cancel_remote(PurpleXfer *xfer)
Cancels a file transfer from the remote end.
void purple_xfer_unref(PurpleXfer *xfer)
Decreases the reference count on a PurpleXfer.
void purple_xfer_request_accepted(PurpleXfer *xfer, const char *filename)
Called if the user accepts the file transfer request.
gssize purple_xfer_read(PurpleXfer *xfer, guchar **buffer)
Reads in data from a file transfer stream.
const char * purple_xfer_get_local_filename(const PurpleXfer *xfer)
Returns the file's destination filename,.
void purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename)
Sets the local filename for the file transfer.
time_t purple_xfer_get_end_time(const PurpleXfer *xfer)
Returns the time the transfer of a file ended.
void purple_xfer_set_thumbnail(PurpleXfer *xfer, gconstpointer thumbnail, gsize size, const gchar *mimetype)
Sets the thumbnail data for a transfer.
double purple_xfer_get_progress(const PurpleXfer *xfer)
Returns the current percentage of progress of the transfer.
void purple_xfer_ref(PurpleXfer *xfer)
Increases the reference count on a PurpleXfer.
PurpleXfer * purple_xfer_new(PurpleAccount *account, PurpleXferType type, const char *who)
Creates a new file transfer handle.
gboolean purple_xfer_is_completed(const PurpleXfer *xfer)
Returns the completed state for a file transfer.
void purple_xfer_set_request_denied_fnc(PurpleXfer *xfer, void(*fnc)(PurpleXfer *))
Sets the function to be called if the request is denied.
void purple_xfer_add(PurpleXfer *xfer)
Adds a new file transfer to the list of file transfers.
PurpleXferUiOps * purple_xfer_get_ui_ops(const PurpleXfer *xfer)
Returns the UI operations structure for a file transfer.
gboolean purple_xfer_write_file(PurpleXfer *xfer, const guchar *buffer, gsize size)
Writes chunk of received file.
PurpleXferUiOps * purple_xfers_get_ui_ops(void)
Returns the UI operations structure to be used in all purple file transfers.
void purple_xfer_set_filename(PurpleXfer *xfer, const char *filename)
Sets the filename for the file transfer.
const char * purple_xfer_get_remote_ip(const PurpleXfer *xfer)
Returns the remote IP address in the file transfer.
time_t purple_xfer_get_start_time(const PurpleXfer *xfer)
Returns the time the transfer of a file started.
void purple_xfer_ui_ready(PurpleXfer *xfer)
Allows the UI to signal it's ready to send/receive data (depending on the direction of the file trans...
void purple_xfer_end(PurpleXfer *xfer)
Ends a file transfer.
void purple_xfer_set_size(PurpleXfer *xfer, size_t size)
Sets the size of the file in a file transfer.
void purple_xfer_set_start_fnc(PurpleXfer *xfer, void(*fnc)(PurpleXfer *))
Sets the start transfer function for the file transfer.
void purple_xfer_request_denied(PurpleXfer *xfer)
Called if the user rejects the file transfer request.
void purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip, unsigned int port)
Starts a file transfer.
void purple_xfer_prpl_ready(PurpleXfer *xfer)
Allows the prpl to signal it's ready to send/receive data (depending on the direction of the file tra...
const char * purple_xfer_get_remote_user(const PurpleXfer *xfer)
Returns the name of the remote user.
void purple_xfer_set_message(PurpleXfer *xfer, const char *message)
Sets the filename for the file transfer.
void purple_xfer_update_progress(PurpleXfer *xfer)
Updates file transfer progress.
void purple_xfer_cancel_local(PurpleXfer *xfer)
Cancels a file transfer on the local end.
const char * purple_xfer_get_filename(const PurpleXfer *xfer)
Returns the name of the file being sent or received.
void purple_xfer_set_read_fnc(PurpleXfer *xfer, gssize(*fnc)(guchar **, PurpleXfer *))
Sets the read function for the file transfer.
gboolean purple_xfer_is_canceled(const PurpleXfer *xfer)
Returns true if the file transfer was cancelled.
PurpleAccount * purple_xfer_get_account(const PurpleXfer *xfer)
Returns the account the file transfer is using.
void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg)
Displays a file transfer-related error message.
void purple_xfer_set_bytes_sent(PurpleXfer *xfer, size_t bytes_sent)
Sets the current working position in the active file transfer.
void purple_xfers_set_ui_ops(PurpleXferUiOps *ops)
Sets the UI operations structure to be used in all purple file transfers.
void purple_xfer_set_cancel_recv_fnc(PurpleXfer *xfer, void(*fnc)(PurpleXfer *))
Sets the cancel receive function for the file transfer.
void * purple_xfers_get_handle(void)
Returns the handle to the file transfer subsystem.
File transfer UI operations.
Definition: ft.h:72
Structure representing an account.
Definition: account.h:170
A core representation of a file transfer.
Definition: ft.h:135
PurpleXferType type
The type of transfer.
Definition: ft.h:137
size_t current_buffer_size
This gradually increases for fast network connections.
Definition: ft.h:163
size_t bytes_sent
The number of bytes sent.
Definition: ft.h:158
char * local_filename
The name on the local hard drive.
Definition: ft.h:146
char * filename
The name sent over the network.
Definition: ft.h:145
PurpleAccount * account
The account.
Definition: ft.h:139
void * data
prpl-specific data.
Definition: ft.h:188
int fd
The socket file descriptor.
Definition: ft.h:155
int remote_port
The remote port.
Definition: ft.h:153
time_t start_time
When the transfer of data began.
Definition: ft.h:160
size_t bytes_remaining
The number of bytes remaining.
Definition: ft.h:159
guint ref
The reference count.
Definition: ft.h:136
struct _PurpleXfer::@2 ops
I/O operations, which should be set by the prpl using purple_xfer_set_init_fnc() and friends.
char * who
The person on the other end of the transfer.
Definition: ft.h:141
int watcher
Watcher.
Definition: ft.h:156
PurpleXferUiOps * ui_ops
UI-specific operations.
Definition: ft.h:185
char * remote_ip
The remote IP address.
Definition: ft.h:151
FILE * dest_fp
The destination file pointer.
Definition: ft.h:149
PurpleXferStatusType status
File Transfer's status.
Definition: ft.h:166
int local_port
The local port.
Definition: ft.h:152
void * ui_data
UI-specific data.
Definition: ft.h:186
size_t size
The size of the file.
Definition: ft.h:147
char * message
A message sent with the request
Definition: ft.h:144
time_t end_time
When the transfer of data ended.
Definition: ft.h:161