Mercurial > pidgin
annotate libgaim/ft.h @ 14956:0b98802a97cf
[gaim-migrate @ 17735]
(09:35:51) Alver: http://studwww.ugent.be/~lvalboom/zephyr.patch
(09:36:03) LSchiere2: how many do you have?
(09:36:14) Alver: That's all so far
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Fri, 10 Nov 2006 14:38:08 +0000 |
parents | 4b2ac755d565 |
children | ec96d6d2fa6d |
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 { | |
87 guint ref; /**< The reference count. */ | |
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 | |
114 GaimXferStatusType status; /**< File Transfer's status. */ | |
115 | |
116 /* I/O operations. */ | |
117 struct | |
118 { | |
119 void (*init)(GaimXfer *xfer); | |
120 void (*request_denied)(GaimXfer *xfer); | |
121 void (*start)(GaimXfer *xfer); | |
122 void (*end)(GaimXfer *xfer); | |
123 void (*cancel_send)(GaimXfer *xfer); | |
124 void (*cancel_recv)(GaimXfer *xfer); | |
125 gssize (*read)(guchar **buffer, GaimXfer *xfer); | |
126 gssize (*write)(const guchar *buffer, size_t size, GaimXfer *xfer); | |
127 void (*ack)(GaimXfer *xfer, const guchar *buffer, size_t size); | |
128 | |
129 } ops; | |
130 | |
131 GaimXferUiOps *ui_ops; /**< UI-specific operations. */ | |
132 void *ui_data; /**< UI-specific data. */ | |
133 | |
134 void *data; /**< prpl-specific data. */ | |
135 }; | |
136 | |
137 #ifdef __cplusplus | |
138 extern "C" { | |
139 #endif | |
140 | |
141 /**************************************************************************/ | |
142 /** @name File Transfer API */ | |
143 /**************************************************************************/ | |
144 /*@{*/ | |
145 | |
146 /** | |
147 * Creates a new file transfer handle. | |
148 * This is called by prpls. | |
149 * The handle starts with a ref count of 1, and this reference | |
150 * is owned by the core. The prpl normally does not need to | |
151 * gaim_xfer_ref or unref. | |
152 * | |
153 * @param account The account sending or receiving the file. | |
154 * @param type The type of file transfer. | |
155 * @param who The name of the remote user. | |
156 * | |
157 * @return A file transfer handle. | |
158 */ | |
159 GaimXfer *gaim_xfer_new(GaimAccount *account, | |
160 GaimXferType type, const char *who); | |
161 | |
162 /** | |
163 * Increases the reference count on a GaimXfer. | |
164 * Please call gaim_xfer_unref later. | |
165 * | |
166 * @param xfer A file transfer handle. | |
167 */ | |
168 void gaim_xfer_ref(GaimXfer *xfer); | |
169 | |
170 /** | |
171 * Decreases the reference count on a GaimXfer. | |
172 * If the reference reaches 0, gaim_xfer_destroy (an internal function) | |
173 * will destroy the xfer. It calls the ui destroy cb first. | |
174 * Since the core keeps a ref on the xfer, only an erroneous call to | |
175 * this function will destroy the xfer while still in use. | |
176 * | |
177 * @param xfer A file transfer handle. | |
178 */ | |
179 void gaim_xfer_unref(GaimXfer *xfer); | |
180 | |
181 /** | |
182 * Requests confirmation for a file transfer from the user. If receiving | |
183 * a file which is known at this point, this requests user to accept and | |
184 * save the file. If the filename is unknown (not set) this only requests user | |
185 * to accept the file transfer. In this case protocol must call this function | |
186 * again once the filename is available. | |
187 * | |
188 * @param xfer The file transfer to request confirmation on. | |
189 */ | |
190 void gaim_xfer_request(GaimXfer *xfer); | |
191 | |
192 /** | |
193 * Called if the user accepts the file transfer request. | |
194 * | |
195 * @param xfer The file transfer. | |
196 * @param filename The filename. | |
197 */ | |
198 void gaim_xfer_request_accepted(GaimXfer *xfer, const char *filename); | |
199 | |
200 /** | |
201 * Called if the user rejects the file transfer request. | |
202 * | |
203 * @param xfer The file transfer. | |
204 */ | |
205 void gaim_xfer_request_denied(GaimXfer *xfer); | |
206 | |
207 /** | |
208 * Returns the type of file transfer. | |
209 * | |
210 * @param xfer The file transfer. | |
211 * | |
212 * @return The type of the file transfer. | |
213 */ | |
214 GaimXferType gaim_xfer_get_type(const GaimXfer *xfer); | |
215 | |
216 /** | |
217 * Returns the account the file transfer is using. | |
218 * | |
219 * @param xfer The file transfer. | |
220 * | |
221 * @return The account. | |
222 */ | |
223 GaimAccount *gaim_xfer_get_account(const GaimXfer *xfer); | |
224 | |
225 /** | |
226 * Returns the status of the xfer. | |
227 * | |
228 * @param xfer The file transfer. | |
229 * | |
230 * @return The status. | |
231 */ | |
232 GaimXferStatusType gaim_xfer_get_status(const GaimXfer *xfer); | |
233 | |
234 /** | |
235 * Returns true if the file transfer was canceled. | |
236 * | |
237 * @param xfer The file transfer. | |
238 * | |
239 * @return Whether or not the transfer was canceled. | |
240 */ | |
241 gboolean gaim_xfer_is_canceled(const GaimXfer *xfer); | |
242 | |
243 /** | |
244 * Returns the completed state for a file transfer. | |
245 * | |
246 * @param xfer The file transfer. | |
247 * | |
248 * @return The completed state. | |
249 */ | |
250 gboolean gaim_xfer_is_completed(const GaimXfer *xfer); | |
251 | |
252 /** | |
253 * Returns the name of the file being sent or received. | |
254 * | |
255 * @param xfer The file transfer. | |
256 * | |
257 * @return The filename. | |
258 */ | |
259 const char *gaim_xfer_get_filename(const GaimXfer *xfer); | |
260 | |
261 /** | |
262 * Returns the file's destination filename, | |
263 * | |
264 * @param xfer The file transfer. | |
265 * | |
266 * @return The destination filename. | |
267 */ | |
268 const char *gaim_xfer_get_local_filename(const GaimXfer *xfer); | |
269 | |
270 /** | |
271 * Returns the number of bytes sent (or received) so far. | |
272 * | |
273 * @param xfer The file transfer. | |
274 * | |
275 * @return The number of bytes sent. | |
276 */ | |
277 size_t gaim_xfer_get_bytes_sent(const GaimXfer *xfer); | |
278 | |
279 /** | |
280 * Returns the number of bytes remaining to send or receive. | |
281 * | |
282 * @param xfer The file transfer. | |
283 * | |
284 * @return The number of bytes remaining. | |
285 */ | |
286 size_t gaim_xfer_get_bytes_remaining(const GaimXfer *xfer); | |
287 | |
288 /** | |
289 * Returns the size of the file being sent or received. | |
290 * | |
291 * @param xfer The file transfer. | |
292 * | |
293 * @return The total size of the file. | |
294 */ | |
295 size_t gaim_xfer_get_size(const GaimXfer *xfer); | |
296 | |
297 /** | |
298 * Returns the current percentage of progress of the transfer. | |
299 * | |
300 * This is a number between 0 (0%) and 1 (100%). | |
301 * | |
302 * @param xfer The file transfer. | |
303 * | |
304 * @return The percentage complete. | |
305 */ | |
306 double gaim_xfer_get_progress(const GaimXfer *xfer); | |
307 | |
308 /** | |
309 * Returns the local port number in the file transfer. | |
310 * | |
311 * @param xfer The file transfer. | |
312 * | |
313 * @return The port number on this end. | |
314 */ | |
315 unsigned int gaim_xfer_get_local_port(const GaimXfer *xfer); | |
316 | |
317 /** | |
318 * Returns the remote IP address in the file transfer. | |
319 * | |
320 * @param xfer The file transfer. | |
321 * | |
322 * @return The IP address on the other end. | |
323 */ | |
324 const char *gaim_xfer_get_remote_ip(const GaimXfer *xfer); | |
325 | |
326 /** | |
327 * Returns the remote port number in the file transfer. | |
328 * | |
329 * @param xfer The file transfer. | |
330 * | |
331 * @return The port number on the other end. | |
332 */ | |
333 unsigned int gaim_xfer_get_remote_port(const GaimXfer *xfer); | |
334 | |
335 /** | |
336 * Sets the completed state for the file transfer. | |
337 * | |
338 * @param xfer The file transfer. | |
339 * @param completed The completed state. | |
340 */ | |
341 void gaim_xfer_set_completed(GaimXfer *xfer, gboolean completed); | |
342 | |
343 /** | |
344 * Sets the filename for the file transfer. | |
345 * | |
346 * @param xfer The file transfer. | |
347 * @param message The message. | |
348 */ | |
349 void gaim_xfer_set_message(GaimXfer *xfer, const char *message); | |
350 | |
351 /** | |
352 * Sets the filename for the file transfer. | |
353 * | |
354 * @param xfer The file transfer. | |
355 * @param filename The filename. | |
356 */ | |
357 void gaim_xfer_set_filename(GaimXfer *xfer, const char *filename); | |
358 | |
359 /** | |
360 * Sets the local filename for the file transfer. | |
361 * | |
362 * @param xfer The file transfer. | |
363 * @param filename The filename | |
364 */ | |
365 void gaim_xfer_set_local_filename(GaimXfer *xfer, const char *filename); | |
366 | |
367 /** | |
368 * Sets the size of the file in a file transfer. | |
369 * | |
370 * @param xfer The file transfer. | |
371 * @param size The size of the file. | |
372 */ | |
373 void gaim_xfer_set_size(GaimXfer *xfer, size_t size); | |
374 | |
375 /** | |
376 * Returns the UI operations structure for a file transfer. | |
377 * | |
378 * @param xfer The file transfer. | |
379 * | |
380 * @return The UI operations structure. | |
381 */ | |
382 GaimXferUiOps *gaim_xfer_get_ui_ops(const GaimXfer *xfer); | |
383 | |
384 /** | |
385 * Sets the read function for the file transfer. | |
386 * | |
387 * @param xfer The file transfer. | |
388 * @param fnc The read function. | |
389 */ | |
390 void gaim_xfer_set_read_fnc(GaimXfer *xfer, | |
391 gssize (*fnc)(guchar **, GaimXfer *)); | |
392 | |
393 /** | |
394 * Sets the write function for the file transfer. | |
395 * | |
396 * @param xfer The file transfer. | |
397 * @param fnc The write function. | |
398 */ | |
399 void gaim_xfer_set_write_fnc(GaimXfer *xfer, | |
400 gssize (*fnc)(const guchar *, size_t, GaimXfer *)); | |
401 | |
402 /** | |
403 * Sets the acknowledge function for the file transfer. | |
404 * | |
405 * @param xfer The file transfer. | |
406 * @param fnc The acknowledge function. | |
407 */ | |
408 void gaim_xfer_set_ack_fnc(GaimXfer *xfer, | |
409 void (*fnc)(GaimXfer *, const guchar *, size_t)); | |
410 | |
411 /** | |
412 * Sets the function to be called if the request is denied. | |
413 * | |
414 * @param xfer The file transfer. | |
415 * @param fnc The request denied prpl callback. | |
416 */ | |
417 void gaim_xfer_set_request_denied_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
418 | |
419 /** | |
420 * Sets the transfer initialization function for the file transfer. | |
421 * | |
422 * This function is required, and must call gaim_xfer_start() with | |
423 * the necessary parameters. This will be called if the file transfer | |
424 * is accepted by the user. | |
425 * | |
426 * @param xfer The file transfer. | |
427 * @param fnc The transfer initialization function. | |
428 */ | |
429 void gaim_xfer_set_init_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
430 | |
431 /** | |
432 * Sets the start transfer function for the file transfer. | |
433 * | |
434 * @param xfer The file transfer. | |
435 * @param fnc The start transfer function. | |
436 */ | |
437 void gaim_xfer_set_start_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
438 | |
439 /** | |
440 * Sets the end transfer function for the file transfer. | |
441 * | |
442 * @param xfer The file transfer. | |
443 * @param fnc The end transfer function. | |
444 */ | |
445 void gaim_xfer_set_end_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
446 | |
447 /** | |
448 * Sets the cancel send function for the file transfer. | |
449 * | |
450 * @param xfer The file transfer. | |
451 * @param fnc The cancel send function. | |
452 */ | |
453 void gaim_xfer_set_cancel_send_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
454 | |
455 /** | |
456 * Sets the cancel receive function for the file transfer. | |
457 * | |
458 * @param xfer The file transfer. | |
459 * @param fnc The cancel receive function. | |
460 */ | |
461 void gaim_xfer_set_cancel_recv_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
462 | |
463 /** | |
464 * Reads in data from a file transfer stream. | |
465 * | |
466 * @param xfer The file transfer. | |
467 * @param buffer The buffer that will be created to contain the data. | |
468 * | |
469 * @return The number of bytes read, or -1. | |
470 */ | |
471 gssize gaim_xfer_read(GaimXfer *xfer, guchar **buffer); | |
472 | |
473 /** | |
474 * Writes data to a file transfer stream. | |
475 * | |
476 * @param xfer The file transfer. | |
477 * @param buffer The buffer to read the data from. | |
478 * @param size The number of bytes to write. | |
479 * | |
480 * @return The number of bytes written, or -1. | |
481 */ | |
482 gssize gaim_xfer_write(GaimXfer *xfer, const guchar *buffer, gsize size); | |
483 | |
484 /** | |
485 * Starts a file transfer. | |
486 * | |
487 * Either @a fd must be specified <i>or</i> @a ip and @a port on a | |
488 * file receive transfer. On send, @a fd must be specified, and | |
489 * @a ip and @a port are ignored. | |
490 * | |
491 * @param xfer The file transfer. | |
492 * @param fd The file descriptor for the socket. | |
493 * @param ip The IP address to connect to. | |
494 * @param port The port to connect to. | |
495 */ | |
496 void gaim_xfer_start(GaimXfer *xfer, int fd, const char *ip, | |
497 unsigned int port); | |
498 | |
499 /** | |
500 * Ends a file transfer. | |
501 * | |
502 * @param xfer The file transfer. | |
503 */ | |
504 void gaim_xfer_end(GaimXfer *xfer); | |
505 | |
506 /** | |
507 * Adds a new file transfer to the list of file transfers. Call this only | |
508 * if you are not using gaim_xfer_start. | |
509 * | |
510 * @param xfer The file transfer. | |
511 */ | |
512 void gaim_xfer_add(GaimXfer *xfer); | |
513 | |
514 /** | |
515 * Cancels a file transfer on the local end. | |
516 * | |
517 * @param xfer The file transfer. | |
518 */ | |
519 void gaim_xfer_cancel_local(GaimXfer *xfer); | |
520 | |
521 /** | |
522 * Cancels a file transfer from the remote end. | |
523 * | |
524 * @param xfer The file transfer. | |
525 */ | |
526 void gaim_xfer_cancel_remote(GaimXfer *xfer); | |
527 | |
528 /** | |
529 * Displays a file transfer-related error message. | |
530 * | |
531 * This is a wrapper around gaim_notify_error(), which automatically | |
532 * specifies a title ("File transfer to <i>user</i> failed" or | |
533 * "File Transfer from <i>user</i> failed"). | |
534 * | |
535 * @param type The type of file transfer. | |
536 * @param account The account sending or receiving the file. | |
537 * @param who The user on the other end of the transfer. | |
538 * @param msg The message to display. | |
539 */ | |
540 void gaim_xfer_error(GaimXferType type, GaimAccount *account, const char *who, const char *msg); | |
541 | |
542 /** | |
543 * Updates file transfer progress. | |
544 * | |
545 * @param xfer The file transfer. | |
546 */ | |
547 void gaim_xfer_update_progress(GaimXfer *xfer); | |
548 | |
549 /** | |
550 * Displays a file transfer-related message in the conversation window | |
551 * | |
552 * This is a wrapper around gaim_conversation_write | |
553 * | |
554 * @param xfer The file transfer to which this message relates. | |
555 * @param message The message to display. | |
556 * @param is_error Is this an error message?. | |
557 */ | |
558 void gaim_xfer_conversation_write(GaimXfer *xfer, char *message, gboolean is_error); | |
559 | |
560 /*@}*/ | |
561 | |
562 /**************************************************************************/ | |
563 /** @name UI Registration Functions */ | |
564 /**************************************************************************/ | |
565 /*@{*/ | |
566 | |
567 /** | |
568 * Returns the handle to the file transfer subsystem | |
569 * | |
570 * @return The handle | |
571 */ | |
572 void *gaim_xfers_get_handle(void); | |
573 | |
574 /** | |
575 * Initializes the file transfer subsystem | |
576 */ | |
577 void gaim_xfers_init(void); | |
578 | |
579 /** | |
580 * Uninitializes the file transfer subsystem | |
581 */ | |
582 void gaim_xfers_uninit(void); | |
583 | |
584 /** | |
585 * Sets the UI operations structure to be used in all gaim file transfers. | |
586 * | |
587 * @param ops The UI operations structure. | |
588 */ | |
589 void gaim_xfers_set_ui_ops(GaimXferUiOps *ops); | |
590 | |
591 /** | |
592 * Returns the UI operations structure to be used in all gaim file transfers. | |
593 * | |
594 * @return The UI operations structure. | |
595 */ | |
596 GaimXferUiOps *gaim_xfers_get_ui_ops(void); | |
597 | |
598 /*@}*/ | |
599 | |
600 #ifdef __cplusplus | |
601 } | |
602 #endif | |
603 | |
604 #endif /* _GAIM_FT_H_ */ |