Mercurial > pidgin
annotate libgaim/ft.h @ 20392:9ba7dee775e1
The first msn-p13-merge-head.diff.gz from SF Patch #1621854 from Ka-Hing Cheung.
"uploaded a diff, this diff is unchanged from the last tarball that I
previously uploaded, except that it's against HEAD. This should be a little
easier for most people."
(This was apparently msn-p13-merge-head.diff, which SourceForge didn't allow to
be uploaded.)
PLUS
"Updated the diff with basically no change, except with simom's icon fix.
The previous diff was broken because some of the files were not added"
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sun, 15 Apr 2007 03:01:41 +0000 |
parents | 5176a9f30ba3 |
children |
rev | line source |
---|---|
14192 | 1 /** |
2 * @file ft.h File Transfer API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Gaim is the legal property of its developers, whose names are too numerous | |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
14938
4b2ac755d565
[gaim-migrate @ 17710]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
14192
diff
changeset
|
24 * |
4b2ac755d565
[gaim-migrate @ 17710]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
14192
diff
changeset
|
25 * @see @ref xfer-signals |
14192 | 26 */ |
27 #ifndef _GAIM_FT_H_ | |
28 #define _GAIM_FT_H_ | |
29 | |
30 /**************************************************************************/ | |
31 /** Data Structures */ | |
32 /**************************************************************************/ | |
33 typedef struct _GaimXfer GaimXfer; | |
34 | |
35 #include <glib.h> | |
36 #include <stdio.h> | |
37 | |
38 #include "account.h" | |
39 | |
40 /** | |
41 * Types of file transfers. | |
42 */ | |
43 typedef enum | |
44 { | |
45 GAIM_XFER_UNKNOWN = 0, /**< Unknown file transfer type. */ | |
46 GAIM_XFER_SEND, /**< File sending. */ | |
47 GAIM_XFER_RECEIVE /**< File receiving. */ | |
48 | |
49 } GaimXferType; | |
50 | |
51 /** | |
52 * The different states of the xfer. | |
53 */ | |
54 typedef enum | |
55 { | |
56 GAIM_XFER_STATUS_UNKNOWN = 0, /**< Unknown, the xfer may be null. */ | |
57 GAIM_XFER_STATUS_NOT_STARTED, /**< It hasn't started yet. */ | |
58 GAIM_XFER_STATUS_ACCEPTED, /**< Receive accepted, but destination file not selected yet */ | |
59 GAIM_XFER_STATUS_STARTED, /**< gaim_xfer_start has been called. */ | |
60 GAIM_XFER_STATUS_DONE, /**< The xfer completed successfully. */ | |
61 GAIM_XFER_STATUS_CANCEL_LOCAL, /**< The xfer was canceled by us. */ | |
62 GAIM_XFER_STATUS_CANCEL_REMOTE /**< The xfer was canceled by the other end, or we couldn't connect. */ | |
63 } GaimXferStatusType; | |
64 | |
65 /** | |
66 * File transfer UI operations. | |
67 * | |
68 * Any UI representing a file transfer must assign a filled-out | |
69 * GaimXferUiOps structure to the gaim_xfer. | |
70 */ | |
71 typedef struct | |
72 { | |
73 void (*new_xfer)(GaimXfer *xfer); | |
74 void (*destroy)(GaimXfer *xfer); | |
75 void (*add_xfer)(GaimXfer *xfer); | |
76 void (*update_progress)(GaimXfer *xfer, double percent); | |
77 void (*cancel_local)(GaimXfer *xfer); | |
78 void (*cancel_remote)(GaimXfer *xfer); | |
79 | |
80 } GaimXferUiOps; | |
81 | |
82 /** | |
83 * A core representation of a file transfer. | |
84 */ | |
85 struct _GaimXfer | |
86 { | |
15218 | 87 guint ref; /**< The reference count. */ |
14192 | 88 GaimXferType type; /**< The type of transfer. */ |
89 | |
90 GaimAccount *account; /**< The account. */ | |
91 | |
92 char *who; /**< The person on the other end of the | |
93 transfer. */ | |
94 | |
95 char *message; /**< A message sent with the request */ | |
96 char *filename; /**< The name sent over the network. */ | |
97 char *local_filename; /**< The name on the local hard drive. */ | |
98 size_t size; /**< The size of the file. */ | |
99 | |
100 FILE *dest_fp; /**< The destination file pointer. */ | |
101 | |
102 char *remote_ip; /**< The remote IP address. */ | |
103 int local_port; /**< The local port. */ | |
104 int remote_port; /**< The remote port. */ | |
105 | |
106 int fd; /**< The socket file descriptor. */ | |
107 int watcher; /**< Watcher. */ | |
108 | |
109 size_t bytes_sent; /**< The number of bytes sent. */ | |
110 size_t bytes_remaining; /**< The number of bytes remaining. */ | |
111 time_t start_time; /**< When the transfer of data began. */ | |
112 time_t end_time; /**< When the transfer of data ended. */ | |
113 | |
15218 | 114 size_t current_buffer_size; /**< This gradually increases for fast |
115 network connections. */ | |
116 | |
14192 | 117 GaimXferStatusType status; /**< File Transfer's status. */ |
118 | |
119 /* I/O operations. */ | |
120 struct | |
121 { | |
122 void (*init)(GaimXfer *xfer); | |
123 void (*request_denied)(GaimXfer *xfer); | |
124 void (*start)(GaimXfer *xfer); | |
125 void (*end)(GaimXfer *xfer); | |
126 void (*cancel_send)(GaimXfer *xfer); | |
127 void (*cancel_recv)(GaimXfer *xfer); | |
128 gssize (*read)(guchar **buffer, GaimXfer *xfer); | |
129 gssize (*write)(const guchar *buffer, size_t size, GaimXfer *xfer); | |
130 void (*ack)(GaimXfer *xfer, const guchar *buffer, size_t size); | |
131 | |
132 } ops; | |
133 | |
134 GaimXferUiOps *ui_ops; /**< UI-specific operations. */ | |
135 void *ui_data; /**< UI-specific data. */ | |
136 | |
137 void *data; /**< prpl-specific data. */ | |
138 }; | |
139 | |
140 #ifdef __cplusplus | |
141 extern "C" { | |
142 #endif | |
143 | |
144 /**************************************************************************/ | |
145 /** @name File Transfer API */ | |
146 /**************************************************************************/ | |
147 /*@{*/ | |
148 | |
149 /** | |
150 * Creates a new file transfer handle. | |
151 * This is called by prpls. | |
152 * The handle starts with a ref count of 1, and this reference | |
153 * is owned by the core. The prpl normally does not need to | |
154 * gaim_xfer_ref or unref. | |
155 * | |
156 * @param account The account sending or receiving the file. | |
157 * @param type The type of file transfer. | |
158 * @param who The name of the remote user. | |
159 * | |
160 * @return A file transfer handle. | |
161 */ | |
162 GaimXfer *gaim_xfer_new(GaimAccount *account, | |
163 GaimXferType type, const char *who); | |
164 | |
165 /** | |
166 * Increases the reference count on a GaimXfer. | |
167 * Please call gaim_xfer_unref later. | |
168 * | |
169 * @param xfer A file transfer handle. | |
170 */ | |
171 void gaim_xfer_ref(GaimXfer *xfer); | |
172 | |
173 /** | |
174 * Decreases the reference count on a GaimXfer. | |
175 * If the reference reaches 0, gaim_xfer_destroy (an internal function) | |
176 * will destroy the xfer. It calls the ui destroy cb first. | |
177 * Since the core keeps a ref on the xfer, only an erroneous call to | |
178 * this function will destroy the xfer while still in use. | |
179 * | |
180 * @param xfer A file transfer handle. | |
181 */ | |
182 void gaim_xfer_unref(GaimXfer *xfer); | |
183 | |
184 /** | |
185 * Requests confirmation for a file transfer from the user. If receiving | |
186 * a file which is known at this point, this requests user to accept and | |
187 * save the file. If the filename is unknown (not set) this only requests user | |
188 * to accept the file transfer. In this case protocol must call this function | |
189 * again once the filename is available. | |
190 * | |
191 * @param xfer The file transfer to request confirmation on. | |
192 */ | |
193 void gaim_xfer_request(GaimXfer *xfer); | |
194 | |
195 /** | |
196 * Called if the user accepts the file transfer request. | |
197 * | |
198 * @param xfer The file transfer. | |
199 * @param filename The filename. | |
200 */ | |
201 void gaim_xfer_request_accepted(GaimXfer *xfer, const char *filename); | |
202 | |
203 /** | |
204 * Called if the user rejects the file transfer request. | |
205 * | |
206 * @param xfer The file transfer. | |
207 */ | |
208 void gaim_xfer_request_denied(GaimXfer *xfer); | |
209 | |
210 /** | |
211 * Returns the type of file transfer. | |
212 * | |
213 * @param xfer The file transfer. | |
214 * | |
215 * @return The type of the file transfer. | |
216 */ | |
217 GaimXferType gaim_xfer_get_type(const GaimXfer *xfer); | |
218 | |
219 /** | |
220 * Returns the account the file transfer is using. | |
221 * | |
222 * @param xfer The file transfer. | |
223 * | |
224 * @return The account. | |
225 */ | |
226 GaimAccount *gaim_xfer_get_account(const GaimXfer *xfer); | |
227 | |
228 /** | |
229 * Returns the status of the xfer. | |
230 * | |
231 * @param xfer The file transfer. | |
232 * | |
233 * @return The status. | |
234 */ | |
235 GaimXferStatusType gaim_xfer_get_status(const GaimXfer *xfer); | |
236 | |
237 /** | |
238 * Returns true if the file transfer was canceled. | |
239 * | |
240 * @param xfer The file transfer. | |
241 * | |
242 * @return Whether or not the transfer was canceled. | |
243 */ | |
244 gboolean gaim_xfer_is_canceled(const GaimXfer *xfer); | |
245 | |
246 /** | |
247 * Returns the completed state for a file transfer. | |
248 * | |
249 * @param xfer The file transfer. | |
250 * | |
251 * @return The completed state. | |
252 */ | |
253 gboolean gaim_xfer_is_completed(const GaimXfer *xfer); | |
254 | |
255 /** | |
256 * Returns the name of the file being sent or received. | |
257 * | |
258 * @param xfer The file transfer. | |
259 * | |
260 * @return The filename. | |
261 */ | |
262 const char *gaim_xfer_get_filename(const GaimXfer *xfer); | |
263 | |
264 /** | |
265 * Returns the file's destination filename, | |
266 * | |
267 * @param xfer The file transfer. | |
268 * | |
269 * @return The destination filename. | |
270 */ | |
271 const char *gaim_xfer_get_local_filename(const GaimXfer *xfer); | |
272 | |
273 /** | |
274 * Returns the number of bytes sent (or received) so far. | |
275 * | |
276 * @param xfer The file transfer. | |
277 * | |
278 * @return The number of bytes sent. | |
279 */ | |
280 size_t gaim_xfer_get_bytes_sent(const GaimXfer *xfer); | |
281 | |
282 /** | |
283 * Returns the number of bytes remaining to send or receive. | |
284 * | |
285 * @param xfer The file transfer. | |
286 * | |
287 * @return The number of bytes remaining. | |
288 */ | |
289 size_t gaim_xfer_get_bytes_remaining(const GaimXfer *xfer); | |
290 | |
291 /** | |
292 * Returns the size of the file being sent or received. | |
293 * | |
294 * @param xfer The file transfer. | |
295 * | |
296 * @return The total size of the file. | |
297 */ | |
298 size_t gaim_xfer_get_size(const GaimXfer *xfer); | |
299 | |
300 /** | |
301 * Returns the current percentage of progress of the transfer. | |
302 * | |
303 * This is a number between 0 (0%) and 1 (100%). | |
304 * | |
305 * @param xfer The file transfer. | |
306 * | |
307 * @return The percentage complete. | |
308 */ | |
309 double gaim_xfer_get_progress(const GaimXfer *xfer); | |
310 | |
311 /** | |
312 * Returns the local port number in the file transfer. | |
313 * | |
314 * @param xfer The file transfer. | |
315 * | |
316 * @return The port number on this end. | |
317 */ | |
318 unsigned int gaim_xfer_get_local_port(const GaimXfer *xfer); | |
319 | |
320 /** | |
321 * Returns the remote IP address in the file transfer. | |
322 * | |
323 * @param xfer The file transfer. | |
324 * | |
325 * @return The IP address on the other end. | |
326 */ | |
327 const char *gaim_xfer_get_remote_ip(const GaimXfer *xfer); | |
328 | |
329 /** | |
330 * Returns the remote port number in the file transfer. | |
331 * | |
332 * @param xfer The file transfer. | |
333 * | |
334 * @return The port number on the other end. | |
335 */ | |
336 unsigned int gaim_xfer_get_remote_port(const GaimXfer *xfer); | |
337 | |
338 /** | |
339 * Sets the completed state for the file transfer. | |
340 * | |
341 * @param xfer The file transfer. | |
342 * @param completed The completed state. | |
343 */ | |
344 void gaim_xfer_set_completed(GaimXfer *xfer, gboolean completed); | |
345 | |
346 /** | |
347 * Sets the filename for the file transfer. | |
348 * | |
349 * @param xfer The file transfer. | |
350 * @param message The message. | |
351 */ | |
352 void gaim_xfer_set_message(GaimXfer *xfer, const char *message); | |
353 | |
354 /** | |
355 * Sets the filename for the file transfer. | |
356 * | |
357 * @param xfer The file transfer. | |
358 * @param filename The filename. | |
359 */ | |
360 void gaim_xfer_set_filename(GaimXfer *xfer, const char *filename); | |
361 | |
362 /** | |
363 * Sets the local filename for the file transfer. | |
364 * | |
365 * @param xfer The file transfer. | |
366 * @param filename The filename | |
367 */ | |
368 void gaim_xfer_set_local_filename(GaimXfer *xfer, const char *filename); | |
369 | |
370 /** | |
371 * Sets the size of the file in a file transfer. | |
372 * | |
373 * @param xfer The file transfer. | |
374 * @param size The size of the file. | |
375 */ | |
376 void gaim_xfer_set_size(GaimXfer *xfer, size_t size); | |
377 | |
378 /** | |
15260 | 379 * Sets the current working position in the active file transfer. This |
380 * can be used to jump backward in the file if the protocol detects | |
381 * that some bit of data needs to be resent or has been sent twice. | |
382 * | |
383 * It's used for pausing and resuming an oscar file transfer. | |
384 * | |
385 * @param xfer The file transfer. | |
386 * @param bytes_sent The new current position in the file. If we're | |
387 * sending a file then this is the byte that we will | |
388 * send. If we're receiving a file, this is the | |
389 * next byte that we expect to receive. | |
390 */ | |
391 void gaim_xfer_set_bytes_sent(GaimXfer *xfer, size_t bytes_sent); | |
392 | |
393 /** | |
14192 | 394 * Returns the UI operations structure for a file transfer. |
395 * | |
396 * @param xfer The file transfer. | |
397 * | |
398 * @return The UI operations structure. | |
399 */ | |
400 GaimXferUiOps *gaim_xfer_get_ui_ops(const GaimXfer *xfer); | |
401 | |
402 /** | |
403 * Sets the read function for the file transfer. | |
404 * | |
405 * @param xfer The file transfer. | |
406 * @param fnc The read function. | |
407 */ | |
408 void gaim_xfer_set_read_fnc(GaimXfer *xfer, | |
409 gssize (*fnc)(guchar **, GaimXfer *)); | |
410 | |
411 /** | |
412 * Sets the write function for the file transfer. | |
413 * | |
414 * @param xfer The file transfer. | |
415 * @param fnc The write function. | |
416 */ | |
417 void gaim_xfer_set_write_fnc(GaimXfer *xfer, | |
418 gssize (*fnc)(const guchar *, size_t, GaimXfer *)); | |
419 | |
420 /** | |
421 * Sets the acknowledge function for the file transfer. | |
422 * | |
423 * @param xfer The file transfer. | |
424 * @param fnc The acknowledge function. | |
425 */ | |
426 void gaim_xfer_set_ack_fnc(GaimXfer *xfer, | |
427 void (*fnc)(GaimXfer *, const guchar *, size_t)); | |
428 | |
429 /** | |
430 * Sets the function to be called if the request is denied. | |
431 * | |
432 * @param xfer The file transfer. | |
433 * @param fnc The request denied prpl callback. | |
434 */ | |
435 void gaim_xfer_set_request_denied_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
436 | |
437 /** | |
438 * Sets the transfer initialization function for the file transfer. | |
439 * | |
440 * This function is required, and must call gaim_xfer_start() with | |
441 * the necessary parameters. This will be called if the file transfer | |
442 * is accepted by the user. | |
443 * | |
444 * @param xfer The file transfer. | |
445 * @param fnc The transfer initialization function. | |
446 */ | |
447 void gaim_xfer_set_init_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
448 | |
449 /** | |
450 * Sets the start transfer function for the file transfer. | |
451 * | |
452 * @param xfer The file transfer. | |
453 * @param fnc The start transfer function. | |
454 */ | |
455 void gaim_xfer_set_start_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
456 | |
457 /** | |
458 * Sets the end transfer function for the file transfer. | |
459 * | |
460 * @param xfer The file transfer. | |
461 * @param fnc The end transfer function. | |
462 */ | |
463 void gaim_xfer_set_end_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
464 | |
465 /** | |
466 * Sets the cancel send function for the file transfer. | |
467 * | |
468 * @param xfer The file transfer. | |
469 * @param fnc The cancel send function. | |
470 */ | |
471 void gaim_xfer_set_cancel_send_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
472 | |
473 /** | |
474 * Sets the cancel receive function for the file transfer. | |
475 * | |
476 * @param xfer The file transfer. | |
477 * @param fnc The cancel receive function. | |
478 */ | |
479 void gaim_xfer_set_cancel_recv_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
480 | |
481 /** | |
482 * Reads in data from a file transfer stream. | |
483 * | |
484 * @param xfer The file transfer. | |
485 * @param buffer The buffer that will be created to contain the data. | |
486 * | |
487 * @return The number of bytes read, or -1. | |
488 */ | |
489 gssize gaim_xfer_read(GaimXfer *xfer, guchar **buffer); | |
490 | |
491 /** | |
492 * Writes data to a file transfer stream. | |
493 * | |
494 * @param xfer The file transfer. | |
495 * @param buffer The buffer to read the data from. | |
496 * @param size The number of bytes to write. | |
497 * | |
498 * @return The number of bytes written, or -1. | |
499 */ | |
500 gssize gaim_xfer_write(GaimXfer *xfer, const guchar *buffer, gsize size); | |
501 | |
502 /** | |
503 * Starts a file transfer. | |
504 * | |
505 * Either @a fd must be specified <i>or</i> @a ip and @a port on a | |
506 * file receive transfer. On send, @a fd must be specified, and | |
507 * @a ip and @a port are ignored. | |
508 * | |
509 * @param xfer The file transfer. | |
510 * @param fd The file descriptor for the socket. | |
511 * @param ip The IP address to connect to. | |
512 * @param port The port to connect to. | |
513 */ | |
514 void gaim_xfer_start(GaimXfer *xfer, int fd, const char *ip, | |
515 unsigned int port); | |
516 | |
517 /** | |
518 * Ends a file transfer. | |
519 * | |
520 * @param xfer The file transfer. | |
521 */ | |
522 void gaim_xfer_end(GaimXfer *xfer); | |
523 | |
524 /** | |
525 * Adds a new file transfer to the list of file transfers. Call this only | |
526 * if you are not using gaim_xfer_start. | |
527 * | |
528 * @param xfer The file transfer. | |
529 */ | |
530 void gaim_xfer_add(GaimXfer *xfer); | |
531 | |
532 /** | |
533 * Cancels a file transfer on the local end. | |
534 * | |
535 * @param xfer The file transfer. | |
536 */ | |
537 void gaim_xfer_cancel_local(GaimXfer *xfer); | |
538 | |
539 /** | |
540 * Cancels a file transfer from the remote end. | |
541 * | |
542 * @param xfer The file transfer. | |
543 */ | |
544 void gaim_xfer_cancel_remote(GaimXfer *xfer); | |
545 | |
546 /** | |
547 * Displays a file transfer-related error message. | |
548 * | |
549 * This is a wrapper around gaim_notify_error(), which automatically | |
550 * specifies a title ("File transfer to <i>user</i> failed" or | |
551 * "File Transfer from <i>user</i> failed"). | |
552 * | |
553 * @param type The type of file transfer. | |
554 * @param account The account sending or receiving the file. | |
555 * @param who The user on the other end of the transfer. | |
556 * @param msg The message to display. | |
557 */ | |
558 void gaim_xfer_error(GaimXferType type, GaimAccount *account, const char *who, const char *msg); | |
559 | |
560 /** | |
561 * Updates file transfer progress. | |
562 * | |
563 * @param xfer The file transfer. | |
564 */ | |
565 void gaim_xfer_update_progress(GaimXfer *xfer); | |
566 | |
567 /** | |
568 * Displays a file transfer-related message in the conversation window | |
569 * | |
570 * This is a wrapper around gaim_conversation_write | |
571 * | |
572 * @param xfer The file transfer to which this message relates. | |
573 * @param message The message to display. | |
574 * @param is_error Is this an error message?. | |
575 */ | |
576 void gaim_xfer_conversation_write(GaimXfer *xfer, char *message, gboolean is_error); | |
577 | |
578 /*@}*/ | |
579 | |
580 /**************************************************************************/ | |
581 /** @name UI Registration Functions */ | |
582 /**************************************************************************/ | |
583 /*@{*/ | |
584 | |
585 /** | |
586 * Returns the handle to the file transfer subsystem | |
587 * | |
588 * @return The handle | |
589 */ | |
590 void *gaim_xfers_get_handle(void); | |
591 | |
592 /** | |
593 * Initializes the file transfer subsystem | |
594 */ | |
595 void gaim_xfers_init(void); | |
596 | |
597 /** | |
598 * Uninitializes the file transfer subsystem | |
599 */ | |
600 void gaim_xfers_uninit(void); | |
601 | |
602 /** | |
603 * Sets the UI operations structure to be used in all gaim file transfers. | |
604 * | |
605 * @param ops The UI operations structure. | |
606 */ | |
607 void gaim_xfers_set_ui_ops(GaimXferUiOps *ops); | |
608 | |
609 /** | |
610 * Returns the UI operations structure to be used in all gaim file transfers. | |
611 * | |
612 * @return The UI operations structure. | |
613 */ | |
614 GaimXferUiOps *gaim_xfers_get_ui_ops(void); | |
615 | |
616 /*@}*/ | |
617 | |
618 #ifdef __cplusplus | |
619 } | |
620 #endif | |
621 | |
622 #endif /* _GAIM_FT_H_ */ |