Mercurial > pidgin.yaz
annotate src/ft.h @ 8664:f95edb58087c
[gaim-migrate @ 9416]
Marc E. (elcomandante) made us a new jabber icon that isn't quite so out
of focus. Thanks Marc!
committer: Tailor Script <tailor@pidgin.im>
author | Nathan Walp <nwalp@pidgin.im> |
---|---|
date | Wed, 14 Apr 2004 12:40:49 +0000 |
parents | e4087b5c0627 |
children | 92cbf9713795 |
rev | line source |
---|---|
4514 | 1 /** |
7820 | 2 * @file ft.h File Transfer API |
5034
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4675
diff
changeset
|
3 * @ingroup core |
4514 | 4 * |
5 * gaim | |
6 * | |
8046 | 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. | |
8231
f50c059b6384
[gaim-migrate @ 8954]
Christian Hammond <chipx86@chipx86.com>
parents:
8211
diff
changeset
|
10 * |
4514 | 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 | |
24 */ | |
25 #ifndef _GAIM_FT_H_ | |
26 #define _GAIM_FT_H_ | |
27 | |
28 /**************************************************************************/ | |
29 /** Data Structures */ | |
30 /**************************************************************************/ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
31 typedef struct _GaimXfer GaimXfer; |
4514 | 32 |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
33 #include "account.h" |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
34 |
4514 | 35 /** |
36 * Types of file transfers. | |
37 */ | |
38 typedef enum | |
39 { | |
40 GAIM_XFER_UNKNOWN = 0, /**< Unknown file transfer type. */ | |
41 GAIM_XFER_SEND, /**< File sending. */ | |
42 GAIM_XFER_RECEIVE /**< File receiving. */ | |
43 | |
44 } GaimXferType; | |
45 | |
7805 | 46 /** |
47 * The different states of the xfer. | |
48 */ | |
7738 | 49 typedef enum |
50 { | |
7805 | 51 GAIM_XFER_STATUS_UNKNOWN = 0, /**< Unknown, the xfer may be null. */ |
52 GAIM_XFER_STATUS_NOT_STARTED, /**< It hasn't started yet. */ | |
8585 | 53 GAIM_XFER_STATUS_ACCEPTED, /**< Receive accepted, but destination file not selected yet */ |
7805 | 54 GAIM_XFER_STATUS_STARTED, /**< gaim_xfer_start has been called. */ |
55 GAIM_XFER_STATUS_DONE, /**< The xfer completed successfully. */ | |
56 GAIM_XFER_STATUS_CANCEL_LOCAL, /**< The xfer was canceled by us. */ | |
7887 | 57 GAIM_XFER_STATUS_CANCEL_REMOTE /**< The xfer was canceled by the other end, or we couldn't connect. */ |
7805 | 58 } GaimXferStatusType; |
7738 | 59 |
4514 | 60 /** |
61 * File transfer UI operations. | |
62 * | |
63 * Any UI representing a file transfer must assign a filled-out | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
64 * GaimXferUiOps structure to the gaim_xfer. |
4514 | 65 */ |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
66 typedef struct |
4514 | 67 { |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
68 void (*new_xfer)(GaimXfer *xfer); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
69 void (*destroy)(GaimXfer *xfer); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
70 void (*request_file)(GaimXfer *xfer); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
71 void (*ask_cancel)(GaimXfer *xfer); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
72 void (*add_xfer)(GaimXfer *xfer); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
73 void (*update_progress)(GaimXfer *xfer, double percent); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
74 void (*cancel_local)(GaimXfer *xfer); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
75 void (*cancel_remote)(GaimXfer *xfer); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
76 |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
77 } GaimXferUiOps; |
4514 | 78 |
79 /** | |
80 * A core representation of a file transfer. | |
81 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
82 struct _GaimXfer |
4514 | 83 { |
7887 | 84 guint ref; /**< The reference count. */ |
4514 | 85 GaimXferType type; /**< The type of transfer. */ |
86 | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
87 GaimAccount *account; /**< The account. */ |
4514 | 88 |
89 char *who; /**< The person on the other end of the | |
90 transfer. */ | |
91 | |
4605 | 92 char *filename; /**< The name sent over the network. */ |
93 char *local_filename; /**< The name on the local hard drive. */ | |
4514 | 94 size_t size; /**< The size of the file. */ |
95 | |
96 FILE *dest_fp; /**< The destination file pointer. */ | |
97 | |
98 char *remote_ip; /**< The remote IP address. */ | |
99 int local_port; /**< The local port. */ | |
100 int remote_port; /**< The remote port. */ | |
101 | |
102 int fd; /**< The socket file descriptor. */ | |
103 int watcher; /**< Watcher. */ | |
104 | |
105 size_t bytes_sent; /**< The number of bytes sent. */ | |
106 size_t bytes_remaining; /**< The number of bytes remaining. */ | |
107 | |
7805 | 108 GaimXferStatusType status; /**< File Transfer's status. */ |
4538 | 109 |
4514 | 110 /* I/O operations. */ |
111 struct | |
112 { | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
113 void (*init)(GaimXfer *xfer); |
7805 | 114 void (*request_denied)(GaimXfer *xfer); |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
115 void (*start)(GaimXfer *xfer); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
116 void (*end)(GaimXfer *xfer); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
117 void (*cancel_send)(GaimXfer *xfer); |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
118 void (*cancel_recv)(GaimXfer *xfer); |
8231
f50c059b6384
[gaim-migrate @ 8954]
Christian Hammond <chipx86@chipx86.com>
parents:
8211
diff
changeset
|
119 ssize_t (*read)(char **buffer, GaimXfer *xfer); |
f50c059b6384
[gaim-migrate @ 8954]
Christian Hammond <chipx86@chipx86.com>
parents:
8211
diff
changeset
|
120 ssize_t (*write)(const char *buffer, size_t size, GaimXfer *xfer); |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
121 void (*ack)(GaimXfer *xfer, const char *buffer, size_t size); |
4514 | 122 |
123 } ops; | |
124 | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
125 GaimXferUiOps *ui_ops; /**< UI-specific operations. */ |
4514 | 126 void *ui_data; /**< UI-specific data. */ |
127 | |
128 void *data; /**< prpl-specific data. */ | |
129 }; | |
130 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
131 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
132 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
133 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
134 |
4514 | 135 /**************************************************************************/ |
136 /** @name File Transfer API */ | |
137 /**************************************************************************/ | |
138 /*@{*/ | |
139 | |
140 /** | |
141 * Creates a new file transfer handle. | |
7805 | 142 * This is called by prpls. |
143 * The handle starts with a ref count of 1, and this reference | |
144 * is owned by the core. The prpl normally does not need to | |
145 * gaim_xfer_ref or unref. | |
4514 | 146 * |
147 * @param account The account sending or receiving the file. | |
148 * @param type The type of file transfer. | |
149 * @param who The name of the remote user. | |
150 * | |
151 * @return A file transfer handle. | |
152 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
153 GaimXfer *gaim_xfer_new(GaimAccount *account, |
4514 | 154 GaimXferType type, const char *who); |
155 | |
156 /** | |
7805 | 157 * Increases the reference count on a GaimXfer. |
158 * Please call gaim_xfer_unref later. | |
4514 | 159 * |
7805 | 160 * @param xfer A file transfer handle. |
4514 | 161 */ |
7805 | 162 void gaim_xfer_ref(GaimXfer *xfer); |
163 | |
164 /** | |
165 * Decreases the reference count on a GaimXfer. | |
166 * If the reference reaches 0, gaim_xfer_destroy (an internal function) | |
167 * will destroy the xfer. It calls the ui destroy cb first. | |
168 * Since the core keeps a ref on the xfer, only an erronous call to | |
169 * this function will destroy the xfer while still in use. | |
170 * | |
171 * @param xfer A file transfer handle. | |
172 */ | |
173 void gaim_xfer_unref(GaimXfer *xfer); | |
4514 | 174 |
175 /** | |
8585 | 176 * Requests confirmation for a file transfer from the user. If receiving |
177 * a file which is known at this point, this requests user to accept and | |
178 * save the file. If the filename is unknown (not set) this only requests user | |
179 * to accept the file transfer. In this case protocol must call this function | |
180 * again once the filename is available. | |
4514 | 181 * |
182 * @param xfer The file transfer to request confirmation on. | |
183 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
184 void gaim_xfer_request(GaimXfer *xfer); |
4514 | 185 |
186 /** | |
187 * Called if the user accepts the file transfer request. | |
188 * | |
189 * @param xfer The file transfer. | |
190 * @param filename The filename. | |
191 */ | |
7805 | 192 void gaim_xfer_request_accepted(GaimXfer *xfer, const char *filename); |
4514 | 193 |
194 /** | |
195 * Called if the user rejects the file transfer request. | |
196 * | |
197 * @param xfer The file transfer. | |
198 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
199 void gaim_xfer_request_denied(GaimXfer *xfer); |
4514 | 200 |
201 /** | |
202 * Returns the type of file transfer. | |
203 * | |
204 * @param xfer The file transfer. | |
205 * | |
206 * @return The type of the file transfer. | |
207 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
208 GaimXferType gaim_xfer_get_type(const GaimXfer *xfer); |
4514 | 209 |
210 /** | |
211 * Returns the account the file transfer is using. | |
212 * | |
213 * @param xfer The file transfer. | |
214 * | |
215 * @return The account. | |
216 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
217 GaimAccount *gaim_xfer_get_account(const GaimXfer *xfer); |
4514 | 218 |
219 /** | |
7805 | 220 * Returns the status of the xfer. |
221 * | |
222 * @param xfer The file transfer. | |
223 * | |
224 * @return The status. | |
225 */ | |
226 GaimXferStatusType gaim_xfer_get_status(const GaimXfer *xfer); | |
227 | |
228 /** | |
7738 | 229 * Returns true if the file transfer was canceled. |
230 * | |
231 * @param xfer The file transfer. | |
232 * | |
233 * @return Whether or not the transfer was canceled. | |
234 */ | |
7805 | 235 gboolean gaim_xfer_is_canceled(const GaimXfer *xfer); |
7738 | 236 |
237 /** | |
4539
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
238 * Returns the completed state for a file transfer. |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
239 * |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
240 * @param xfer The file transfer. |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
241 * |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
242 * @return The completed state. |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
243 */ |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
244 gboolean gaim_xfer_is_completed(const GaimXfer *xfer); |
4539
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
245 |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
246 /** |
4514 | 247 * Returns the name of the file being sent or received. |
248 * | |
249 * @param xfer The file transfer. | |
250 * | |
251 * @return The filename. | |
252 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
253 const char *gaim_xfer_get_filename(const GaimXfer *xfer); |
4514 | 254 |
255 /** | |
256 * Returns the file's destination filename, | |
257 * | |
258 * @param xfer The file transfer. | |
259 * | |
260 * @return The destination filename. | |
261 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
262 const char *gaim_xfer_get_local_filename(const GaimXfer *xfer); |
4514 | 263 |
264 /** | |
265 * Returns the number of bytes sent so far. | |
266 * | |
267 * @param xfer The file transfer. | |
268 * | |
269 * @return The number of bytes sent. | |
270 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
271 size_t gaim_xfer_get_bytes_sent(const GaimXfer *xfer); |
4514 | 272 |
273 /** | |
274 * Returns the number of bytes received so far. | |
275 * | |
276 * @param xfer The file transfer. | |
277 * | |
278 * @return The number of bytes received. | |
279 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
280 size_t gaim_xfer_get_bytes_remaining(const GaimXfer *xfer); |
4514 | 281 |
282 /** | |
283 * Returns the size of the file being sent or received. | |
284 * | |
285 * @param xfer The file transfer. | |
7805 | 286 * |
4514 | 287 * @return The total size of the file. |
288 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
289 size_t gaim_xfer_get_size(const GaimXfer *xfer); |
4514 | 290 |
291 /** | |
292 * Returns the current percentage of progress of the transfer. | |
293 * | |
294 * This is a number between 0 (0%) and 1 (100%). | |
295 * | |
296 * @param xfer The file transfer. | |
297 * | |
298 * @return The percentage complete. | |
299 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
300 double gaim_xfer_get_progress(const GaimXfer *xfer); |
4514 | 301 |
302 /** | |
303 * Returns the local port number in the file transfer. | |
304 * | |
305 * @param xfer The file transfer. | |
306 * | |
307 * @return The port number on this end. | |
308 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
309 unsigned int gaim_xfer_get_local_port(const GaimXfer *xfer); |
4514 | 310 |
311 /** | |
312 * Returns the remote IP address in the file transfer. | |
313 * | |
314 * @param xfer The file transfer. | |
315 * | |
316 * @return The IP address on the other end. | |
317 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
318 const char *gaim_xfer_get_remote_ip(const GaimXfer *xfer); |
4514 | 319 |
320 /** | |
321 * Returns the remote port number in the file transfer. | |
322 * | |
323 * @param xfer The file transfer. | |
324 * | |
325 * @return The port number on the other end. | |
326 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
327 unsigned int gaim_xfer_get_remote_port(const GaimXfer *xfer); |
4514 | 328 |
329 /** | |
4538 | 330 * Sets the completed state for the file transfer. |
331 * | |
332 * @param xfer The file transfer. | |
333 * @param completed The completed state. | |
334 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
335 void gaim_xfer_set_completed(GaimXfer *xfer, gboolean completed); |
4538 | 336 |
337 /** | |
4514 | 338 * Sets the filename for the file transfer. |
339 * | |
340 * @param xfer The file transfer. | |
341 * @param filename The filename. | |
342 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
343 void gaim_xfer_set_filename(GaimXfer *xfer, const char *filename); |
4514 | 344 |
345 /** | |
4605 | 346 * Sets the local filename for the file transfer. |
4514 | 347 * |
348 * @param xfer The file transfer. | |
349 * @param filename The filename | |
350 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
351 void gaim_xfer_set_local_filename(GaimXfer *xfer, const char *filename); |
4514 | 352 |
353 /** | |
354 * Sets the size of the file in a file transfer. | |
355 * | |
356 * @param xfer The file transfer. | |
357 * @param size The size of the file. | |
358 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
359 void gaim_xfer_set_size(GaimXfer *xfer, size_t size); |
4514 | 360 |
361 /** | |
362 * Returns the UI operations structure for a file transfer. | |
363 * | |
364 * @param xfer The file transfer. | |
365 * | |
366 * @return The UI operations structure. | |
367 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
368 GaimXferUiOps *gaim_xfer_get_ui_ops(const GaimXfer *xfer); |
4514 | 369 |
370 /** | |
371 * Sets the read function for the file transfer. | |
372 * | |
373 * @param xfer The file transfer. | |
374 * @param fnc The read function. | |
375 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
376 void gaim_xfer_set_read_fnc(GaimXfer *xfer, |
8231
f50c059b6384
[gaim-migrate @ 8954]
Christian Hammond <chipx86@chipx86.com>
parents:
8211
diff
changeset
|
377 ssize_t (*fnc)(char **, GaimXfer *)); |
4514 | 378 |
379 /** | |
380 * Sets the write function for the file transfer. | |
381 * | |
382 * @param xfer The file transfer. | |
383 * @param fnc The write function. | |
384 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
385 void gaim_xfer_set_write_fnc(GaimXfer *xfer, |
8231
f50c059b6384
[gaim-migrate @ 8954]
Christian Hammond <chipx86@chipx86.com>
parents:
8211
diff
changeset
|
386 ssize_t (*fnc)(const char *, size_t, GaimXfer *)); |
4514 | 387 |
388 /** | |
389 * Sets the acknowledge function for the file transfer. | |
390 * | |
391 * @param xfer The file transfer. | |
392 * @param fnc The acknowledge function. | |
393 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
394 void gaim_xfer_set_ack_fnc(GaimXfer *xfer, |
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
395 void (*fnc)(GaimXfer *, const char *, size_t)); |
4514 | 396 |
397 /** | |
7805 | 398 * Sets the function to be called if the request is denied. |
399 * | |
400 * @param xfer The file transfer. | |
401 * @param fnc The request denied prpl callback. | |
402 */ | |
403 void gaim_xfer_set_request_denied_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); | |
404 | |
405 /** | |
4514 | 406 * Sets the transfer initialization function for the file transfer. |
407 * | |
408 * This function is required, and must call gaim_xfer_start() with | |
409 * the necessary parameters. This will be called if the file transfer | |
410 * is accepted by the user. | |
411 * | |
412 * @param xfer The file transfer. | |
413 * @param fnc The transfer initialization function. | |
414 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
415 void gaim_xfer_set_init_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); |
4514 | 416 |
417 /** | |
418 * Sets the start transfer function for the file transfer. | |
419 * | |
420 * @param xfer The file transfer. | |
421 * @param fnc The start transfer function. | |
422 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
423 void gaim_xfer_set_start_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); |
4514 | 424 |
425 /** | |
426 * Sets the end transfer function for the file transfer. | |
427 * | |
428 * @param xfer The file transfer. | |
429 * @param fnc The end transfer function. | |
430 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
431 void gaim_xfer_set_end_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); |
4514 | 432 |
433 /** | |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
434 * Sets the cancel send function for the file transfer. |
4514 | 435 * |
436 * @param xfer The file transfer. | |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
437 * @param fnc The cancel send function. |
4514 | 438 */ |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
439 void gaim_xfer_set_cancel_send_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
440 |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
441 /** |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
442 * Sets the cancel receive function for the file transfer. |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
443 * |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
444 * @param xfer The file transfer. |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
445 * @param fnc The cancel receive function. |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
446 */ |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
447 void gaim_xfer_set_cancel_recv_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); |
4514 | 448 |
449 /** | |
450 * Reads in data from a file transfer stream. | |
451 * | |
452 * @param xfer The file transfer. | |
453 * @param buffer The buffer that will be created to contain the data. | |
454 * | |
8231
f50c059b6384
[gaim-migrate @ 8954]
Christian Hammond <chipx86@chipx86.com>
parents:
8211
diff
changeset
|
455 * @return The number of bytes read, or -1. |
4514 | 456 */ |
8231
f50c059b6384
[gaim-migrate @ 8954]
Christian Hammond <chipx86@chipx86.com>
parents:
8211
diff
changeset
|
457 ssize_t gaim_xfer_read(GaimXfer *xfer, char **buffer); |
4514 | 458 |
459 /** | |
460 * Writes data to a file transfer stream. | |
461 * | |
462 * @param xfer The file transfer. | |
463 * @param buffer The buffer to read the data from. | |
464 * @param size The number of bytes to write. | |
465 * | |
8231
f50c059b6384
[gaim-migrate @ 8954]
Christian Hammond <chipx86@chipx86.com>
parents:
8211
diff
changeset
|
466 * @return The number of bytes written, or -1. |
4514 | 467 */ |
8231
f50c059b6384
[gaim-migrate @ 8954]
Christian Hammond <chipx86@chipx86.com>
parents:
8211
diff
changeset
|
468 ssize_t gaim_xfer_write(GaimXfer *xfer, const char *buffer, size_t size); |
4514 | 469 |
470 /** | |
471 * Starts a file transfer. | |
472 * | |
473 * Either @a fd must be specified <i>or</i> @a ip and @a port on a | |
474 * file receive transfer. On send, @a fd must be specified, and | |
475 * @a ip and @a port are ignored. | |
476 * | |
477 * @param xfer The file transfer. | |
478 * @param fd The file descriptor for the socket. | |
479 * @param ip The IP address to connect to. | |
480 * @param port The port to connect to. | |
481 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
482 void gaim_xfer_start(GaimXfer *xfer, int fd, const char *ip, |
4514 | 483 unsigned int port); |
484 | |
485 /** | |
486 * Ends a file transfer. | |
487 * | |
488 * @param xfer The file transfer. | |
489 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
490 void gaim_xfer_end(GaimXfer *xfer); |
4514 | 491 |
492 /** | |
8585 | 493 * Adds a new file transfer to the list of file transfers. Call this only |
494 * if you are not using gaim_xfer_start. | |
495 * | |
496 * @param xfer The file transfer. | |
497 */ | |
498 void gaim_xfer_add(GaimXfer *xfer); | |
499 | |
500 /** | |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
501 * Cancels a file transfer on the local end. |
4514 | 502 * |
503 * @param xfer The file transfer. | |
504 */ | |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
505 void gaim_xfer_cancel_local(GaimXfer *xfer); |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
506 |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
507 /** |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
508 * Cancels a file transfer from the remote end. |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
509 * |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
510 * @param xfer The file transfer. |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
511 */ |
6240
ac191233b816
[gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
512 void gaim_xfer_cancel_remote(GaimXfer *xfer); |
4514 | 513 |
514 /** | |
515 * Displays a file transfer-related error message. | |
516 * | |
5499
c8afb821df3e
[gaim-migrate @ 5895]
Christian Hammond <chipx86@chipx86.com>
parents:
5495
diff
changeset
|
517 * This is a wrapper around gaim_notify_error(), which automatically |
4514 | 518 * specifies a title ("File transfer to <i>user</i> aborted" or |
519 * "File Transfer from <i>user</i> aborted"). | |
520 * | |
521 * @param type The type of file transfer. | |
522 * @param who The user on the other end of the transfer. | |
523 * @param msg The message to display. | |
524 */ | |
525 void gaim_xfer_error(GaimXferType type, const char *who, const char *msg); | |
526 | |
8585 | 527 /** |
528 * Updates file transfer progress. | |
529 * | |
530 * @param xfer The file transfer. | |
531 */ | |
532 void gaim_xfer_update_progress(GaimXfer *xfer); | |
533 | |
6263
3565ee7a5dd3
[gaim-migrate @ 6760]
Christian Hammond <chipx86@chipx86.com>
parents:
6241
diff
changeset
|
534 /*@}*/ |
3565ee7a5dd3
[gaim-migrate @ 6760]
Christian Hammond <chipx86@chipx86.com>
parents:
6241
diff
changeset
|
535 |
3565ee7a5dd3
[gaim-migrate @ 6760]
Christian Hammond <chipx86@chipx86.com>
parents:
6241
diff
changeset
|
536 /**************************************************************************/ |
4514 | 537 /** @name UI Registration Functions */ |
538 /**************************************************************************/ | |
539 /*@{*/ | |
540 | |
541 /** | |
542 * Sets the UI operations structure to be used in all gaim file transfers. | |
543 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6269
diff
changeset
|
544 * @param ops The UI operations structure. |
4514 | 545 */ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
546 void gaim_xfers_set_ui_ops(GaimXferUiOps *ops); |
4514 | 547 |
548 /** | |
549 * Returns the UI operations structure to be used in all gaim file transfers. | |
550 * | |
551 * @return The UI operations structure. | |
552 */ | |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
553 GaimXferUiOps *gaim_xfers_get_ui_ops(void); |
4514 | 554 |
555 /*@}*/ | |
556 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
557 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
558 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
559 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
560 |
4514 | 561 #endif /* _GAIM_FT_H_ */ |