Mercurial > pidgin
comparison src/ft.h @ 6240:ac191233b816
[gaim-migrate @ 6734]
Updated the file transfer API to resemble that of the rest of Gaim's API.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Sun, 20 Jul 2003 03:30:43 +0000 |
parents | 158196b2db19 |
children | 9ce44a7f9ae7 |
comparison
equal
deleted
inserted
replaced
6239:8d10cdfe1bb1 | 6240:ac191233b816 |
---|---|
24 #define _GAIM_FT_H_ | 24 #define _GAIM_FT_H_ |
25 | 25 |
26 /**************************************************************************/ | 26 /**************************************************************************/ |
27 /** Data Structures */ | 27 /** Data Structures */ |
28 /**************************************************************************/ | 28 /**************************************************************************/ |
29 struct gaim_xfer; | 29 typedef struct _GaimXfer GaimXfer; |
30 | 30 |
31 #include "account.h" | 31 #include "account.h" |
32 | 32 |
33 /** | 33 /** |
34 * Types of file transfers. | 34 * Types of file transfers. |
43 | 43 |
44 /** | 44 /** |
45 * File transfer UI operations. | 45 * File transfer UI operations. |
46 * | 46 * |
47 * Any UI representing a file transfer must assign a filled-out | 47 * Any UI representing a file transfer must assign a filled-out |
48 * gaim_xfer_ui_ops structure to the gaim_xfer. | 48 * GaimXferUiOps structure to the gaim_xfer. |
49 */ | 49 */ |
50 struct gaim_xfer_ui_ops | 50 typedef struct |
51 { | 51 { |
52 void (*new)(struct gaim_xfer *xfer); | 52 void (*new_xfer)(GaimXfer *xfer); |
53 void (*destroy)(struct gaim_xfer *xfer); | 53 void (*destroy)(GaimXfer *xfer); |
54 void (*request_file)(struct gaim_xfer *xfer); | 54 void (*request_file)(GaimXfer *xfer); |
55 void (*ask_cancel)(struct gaim_xfer *xfer); | 55 void (*ask_cancel)(GaimXfer *xfer); |
56 void (*add_xfer)(struct gaim_xfer *xfer); | 56 void (*add_xfer)(GaimXfer *xfer); |
57 void (*update_progress)(struct gaim_xfer *xfer, double percent); | 57 void (*update_progress)(GaimXfer *xfer, double percent); |
58 void (*cancel_local)(struct gaim_xfer *xfer); | 58 void (*cancel_local)(GaimXfer *xfer); |
59 void (*cancel_remote)(struct gaim_xfer *xfer); | 59 void (*cancel_remote)(GaimXfer *xfer); |
60 }; | 60 |
61 } GaimXferUiOps; | |
61 | 62 |
62 /** | 63 /** |
63 * A core representation of a file transfer. | 64 * A core representation of a file transfer. |
64 */ | 65 */ |
65 struct gaim_xfer | 66 struct _GaimXfer |
66 { | 67 { |
67 GaimXferType type; /**< The type of transfer. */ | 68 GaimXferType type; /**< The type of transfer. */ |
68 | 69 |
69 GaimAccount *account; /**< The account. */ | 70 GaimAccount *account; /**< The account. */ |
70 | 71 |
71 char *who; /**< The person on the other end of the | 72 char *who; /**< The person on the other end of the |
72 transfer. */ | 73 transfer. */ |
73 | 74 |
74 char *filename; /**< The name sent over the network. */ | 75 char *filename; /**< The name sent over the network. */ |
91 gboolean completed; /**< File Transfer is completed. */ | 92 gboolean completed; /**< File Transfer is completed. */ |
92 | 93 |
93 /* I/O operations. */ | 94 /* I/O operations. */ |
94 struct | 95 struct |
95 { | 96 { |
96 void (*init)(struct gaim_xfer *xfer); | 97 void (*init)(GaimXfer *xfer); |
97 void (*start)(struct gaim_xfer *xfer); | 98 void (*start)(GaimXfer *xfer); |
98 void (*end)(struct gaim_xfer *xfer); | 99 void (*end)(GaimXfer *xfer); |
99 void (*cancel_send)(struct gaim_xfer *xfer); | 100 void (*cancel_send)(GaimXfer *xfer); |
100 void (*cancel_recv)(struct gaim_xfer *xfer); | 101 void (*cancel_recv)(GaimXfer *xfer); |
101 size_t (*read)(char **buffer, struct gaim_xfer *xfer); | 102 size_t (*read)(char **buffer, GaimXfer *xfer); |
102 size_t (*write)(const char *buffer, size_t size, | 103 size_t (*write)(const char *buffer, size_t size, GaimXfer *xfer); |
103 struct gaim_xfer *xfer); | 104 void (*ack)(GaimXfer *xfer, const char *buffer, size_t size); |
104 void (*ack)(struct gaim_xfer *xfer, const char *buffer, | |
105 size_t size); | |
106 | 105 |
107 } ops; | 106 } ops; |
108 | 107 |
109 struct gaim_xfer_ui_ops *ui_ops; /**< UI-specific operations. */ | 108 GaimXferUiOps *ui_ops; /**< UI-specific operations. */ |
110 void *ui_data; /**< UI-specific data. */ | 109 void *ui_data; /**< UI-specific data. */ |
111 | 110 |
112 void *data; /**< prpl-specific data. */ | 111 void *data; /**< prpl-specific data. */ |
113 }; | 112 }; |
114 | 113 |
128 * @param type The type of file transfer. | 127 * @param type The type of file transfer. |
129 * @param who The name of the remote user. | 128 * @param who The name of the remote user. |
130 * | 129 * |
131 * @return A file transfer handle. | 130 * @return A file transfer handle. |
132 */ | 131 */ |
133 struct gaim_xfer *gaim_xfer_new(GaimAccount *account, | 132 GaimXfer *gaim_xfer_new(GaimAccount *account, |
134 GaimXferType type, const char *who); | 133 GaimXferType type, const char *who); |
135 | 134 |
136 /** | 135 /** |
137 * Destroys a file transfer handle. | 136 * Destroys a file transfer handle. |
138 * | 137 * |
139 * @param xfer The file transfer to destroy. | 138 * @param xfer The file transfer to destroy. |
140 */ | 139 */ |
141 void gaim_xfer_destroy(struct gaim_xfer *xfer); | 140 void gaim_xfer_destroy(GaimXfer *xfer); |
142 | 141 |
143 /** | 142 /** |
144 * Requests confirmation for a file transfer from the user. | 143 * Requests confirmation for a file transfer from the user. |
145 * | 144 * |
146 * @param xfer The file transfer to request confirmation on. | 145 * @param xfer The file transfer to request confirmation on. |
147 */ | 146 */ |
148 void gaim_xfer_request(struct gaim_xfer *xfer); | 147 void gaim_xfer_request(GaimXfer *xfer); |
149 | 148 |
150 /** | 149 /** |
151 * Called if the user accepts the file transfer request. | 150 * Called if the user accepts the file transfer request. |
152 * | 151 * |
153 * @param xfer The file transfer. | 152 * @param xfer The file transfer. |
154 * @param filename The filename. | 153 * @param filename The filename. |
155 */ | 154 */ |
156 void gaim_xfer_request_accepted(struct gaim_xfer *xfer, char *filename); | 155 void gaim_xfer_request_accepted(GaimXfer *xfer, char *filename); |
157 | 156 |
158 /** | 157 /** |
159 * Called if the user rejects the file transfer request. | 158 * Called if the user rejects the file transfer request. |
160 * | 159 * |
161 * @param xfer The file transfer. | 160 * @param xfer The file transfer. |
162 */ | 161 */ |
163 void gaim_xfer_request_denied(struct gaim_xfer *xfer); | 162 void gaim_xfer_request_denied(GaimXfer *xfer); |
164 | 163 |
165 /** | 164 /** |
166 * Returns the type of file transfer. | 165 * Returns the type of file transfer. |
167 * | 166 * |
168 * @param xfer The file transfer. | 167 * @param xfer The file transfer. |
169 * | 168 * |
170 * @return The type of the file transfer. | 169 * @return The type of the file transfer. |
171 */ | 170 */ |
172 GaimXferType gaim_xfer_get_type(const struct gaim_xfer *xfer); | 171 GaimXferType gaim_xfer_get_type(const GaimXfer *xfer); |
173 | 172 |
174 /** | 173 /** |
175 * Returns the account the file transfer is using. | 174 * Returns the account the file transfer is using. |
176 * | 175 * |
177 * @param xfer The file transfer. | 176 * @param xfer The file transfer. |
178 * | 177 * |
179 * @return The account. | 178 * @return The account. |
180 */ | 179 */ |
181 GaimAccount *gaim_xfer_get_account(const struct gaim_xfer *xfer); | 180 GaimAccount *gaim_xfer_get_account(const GaimXfer *xfer); |
182 | 181 |
183 /** | 182 /** |
184 * Returns the completed state for a file transfer. | 183 * Returns the completed state for a file transfer. |
185 * | 184 * |
186 * @param xfer The file transfer. | 185 * @param xfer The file transfer. |
187 * | 186 * |
188 * @return The completed state. | 187 * @return The completed state. |
189 */ | 188 */ |
190 gboolean gaim_xfer_is_completed(const struct gaim_xfer *xfer); | 189 gboolean gaim_xfer_is_completed(const GaimXfer *xfer); |
191 | 190 |
192 /** | 191 /** |
193 * Returns the name of the file being sent or received. | 192 * Returns the name of the file being sent or received. |
194 * | 193 * |
195 * @param xfer The file transfer. | 194 * @param xfer The file transfer. |
196 * | 195 * |
197 * @return The filename. | 196 * @return The filename. |
198 */ | 197 */ |
199 const char *gaim_xfer_get_filename(const struct gaim_xfer *xfer); | 198 const char *gaim_xfer_get_filename(const GaimXfer *xfer); |
200 | 199 |
201 /** | 200 /** |
202 * Returns the file's destination filename, | 201 * Returns the file's destination filename, |
203 * | 202 * |
204 * @param xfer The file transfer. | 203 * @param xfer The file transfer. |
205 * | 204 * |
206 * @return The destination filename. | 205 * @return The destination filename. |
207 */ | 206 */ |
208 const char *gaim_xfer_get_local_filename(const struct gaim_xfer *xfer); | 207 const char *gaim_xfer_get_local_filename(const GaimXfer *xfer); |
209 | 208 |
210 /** | 209 /** |
211 * Returns the number of bytes sent so far. | 210 * Returns the number of bytes sent so far. |
212 * | 211 * |
213 * @param xfer The file transfer. | 212 * @param xfer The file transfer. |
214 * | 213 * |
215 * @return The number of bytes sent. | 214 * @return The number of bytes sent. |
216 */ | 215 */ |
217 size_t gaim_xfer_get_bytes_sent(const struct gaim_xfer *xfer); | 216 size_t gaim_xfer_get_bytes_sent(const GaimXfer *xfer); |
218 | 217 |
219 /** | 218 /** |
220 * Returns the number of bytes received so far. | 219 * Returns the number of bytes received so far. |
221 * | 220 * |
222 * @param xfer The file transfer. | 221 * @param xfer The file transfer. |
223 * | 222 * |
224 * @return The number of bytes received. | 223 * @return The number of bytes received. |
225 */ | 224 */ |
226 size_t gaim_xfer_get_bytes_remaining(const struct gaim_xfer *xfer); | 225 size_t gaim_xfer_get_bytes_remaining(const GaimXfer *xfer); |
227 | 226 |
228 /** | 227 /** |
229 * Returns the size of the file being sent or received. | 228 * Returns the size of the file being sent or received. |
230 * | 229 * |
231 * @param xfer The file transfer. | 230 * @param xfer The file transfer. |
232 * | 231 * |
233 * @return The total size of the file. | 232 * @return The total size of the file. |
234 */ | 233 */ |
235 size_t gaim_xfer_get_size(const struct gaim_xfer *xfer); | 234 size_t gaim_xfer_get_size(const GaimXfer *xfer); |
236 | 235 |
237 /** | 236 /** |
238 * Returns the current percentage of progress of the transfer. | 237 * Returns the current percentage of progress of the transfer. |
239 * | 238 * |
240 * This is a number between 0 (0%) and 1 (100%). | 239 * This is a number between 0 (0%) and 1 (100%). |
241 * | 240 * |
242 * @param xfer The file transfer. | 241 * @param xfer The file transfer. |
243 * | 242 * |
244 * @return The percentage complete. | 243 * @return The percentage complete. |
245 */ | 244 */ |
246 double gaim_xfer_get_progress(const struct gaim_xfer *xfer); | 245 double gaim_xfer_get_progress(const GaimXfer *xfer); |
247 | 246 |
248 /** | 247 /** |
249 * Returns the local IP address in the file transfer. | 248 * Returns the local IP address in the file transfer. |
250 * | 249 * |
251 * @param xfer The file transfer. | 250 * @param xfer The file transfer. |
252 * | 251 * |
253 * @return The IP address on this end. | 252 * @return The IP address on this end. |
254 */ | 253 */ |
255 const char *gaim_xfer_get_local_ip(const struct gaim_xfer *xfer); | 254 const char *gaim_xfer_get_local_ip(const GaimXfer *xfer); |
256 | 255 |
257 /** | 256 /** |
258 * Returns the local port number in the file transfer. | 257 * Returns the local port number in the file transfer. |
259 * | 258 * |
260 * @param xfer The file transfer. | 259 * @param xfer The file transfer. |
261 * | 260 * |
262 * @return The port number on this end. | 261 * @return The port number on this end. |
263 */ | 262 */ |
264 unsigned int gaim_xfer_get_local_port(const struct gaim_xfer *xfer); | 263 unsigned int gaim_xfer_get_local_port(const GaimXfer *xfer); |
265 | 264 |
266 /** | 265 /** |
267 * Returns the remote IP address in the file transfer. | 266 * Returns the remote IP address in the file transfer. |
268 * | 267 * |
269 * @param xfer The file transfer. | 268 * @param xfer The file transfer. |
270 * | 269 * |
271 * @return The IP address on the other end. | 270 * @return The IP address on the other end. |
272 */ | 271 */ |
273 const char *gaim_xfer_get_remote_ip(const struct gaim_xfer *xfer); | 272 const char *gaim_xfer_get_remote_ip(const GaimXfer *xfer); |
274 | 273 |
275 /** | 274 /** |
276 * Returns the remote port number in the file transfer. | 275 * Returns the remote port number in the file transfer. |
277 * | 276 * |
278 * @param xfer The file transfer. | 277 * @param xfer The file transfer. |
279 * | 278 * |
280 * @return The port number on the other end. | 279 * @return The port number on the other end. |
281 */ | 280 */ |
282 unsigned int gaim_xfer_get_remote_port(const struct gaim_xfer *xfer); | 281 unsigned int gaim_xfer_get_remote_port(const GaimXfer *xfer); |
283 | 282 |
284 /** | 283 /** |
285 * Sets the completed state for the file transfer. | 284 * Sets the completed state for the file transfer. |
286 * | 285 * |
287 * @param xfer The file transfer. | 286 * @param xfer The file transfer. |
288 * @param completed The completed state. | 287 * @param completed The completed state. |
289 */ | 288 */ |
290 void gaim_xfer_set_completed(struct gaim_xfer *xfer, gboolean completed); | 289 void gaim_xfer_set_completed(GaimXfer *xfer, gboolean completed); |
291 | 290 |
292 /** | 291 /** |
293 * Sets the filename for the file transfer. | 292 * Sets the filename for the file transfer. |
294 * | 293 * |
295 * @param xfer The file transfer. | 294 * @param xfer The file transfer. |
296 * @param filename The filename. | 295 * @param filename The filename. |
297 */ | 296 */ |
298 void gaim_xfer_set_filename(struct gaim_xfer *xfer, const char *filename); | 297 void gaim_xfer_set_filename(GaimXfer *xfer, const char *filename); |
299 | 298 |
300 /** | 299 /** |
301 * Sets the local filename for the file transfer. | 300 * Sets the local filename for the file transfer. |
302 * | 301 * |
303 * @param xfer The file transfer. | 302 * @param xfer The file transfer. |
304 * @param filename The filename | 303 * @param filename The filename |
305 */ | 304 */ |
306 void gaim_xfer_set_local_filename(struct gaim_xfer *xfer, const char *filename); | 305 void gaim_xfer_set_local_filename(GaimXfer *xfer, const char *filename); |
307 | 306 |
308 /** | 307 /** |
309 * Sets the size of the file in a file transfer. | 308 * Sets the size of the file in a file transfer. |
310 * | 309 * |
311 * @param xfer The file transfer. | 310 * @param xfer The file transfer. |
312 * @param size The size of the file. | 311 * @param size The size of the file. |
313 */ | 312 */ |
314 void gaim_xfer_set_size(struct gaim_xfer *xfer, size_t size); | 313 void gaim_xfer_set_size(GaimXfer *xfer, size_t size); |
315 | 314 |
316 /** | 315 /** |
317 * Returns the UI operations structure for a file transfer. | 316 * Returns the UI operations structure for a file transfer. |
318 * | 317 * |
319 * @param xfer The file transfer. | 318 * @param xfer The file transfer. |
320 * | 319 * |
321 * @return The UI operations structure. | 320 * @return The UI operations structure. |
322 */ | 321 */ |
323 struct gaim_xfer_ui_ops *gaim_xfer_get_ui_ops(const struct gaim_xfer *xfer); | 322 GaimXferUiOps *gaim_xfer_get_ui_ops(const GaimXfer *xfer); |
324 | 323 |
325 /** | 324 /** |
326 * Sets the read function for the file transfer. | 325 * Sets the read function for the file transfer. |
327 * | 326 * |
328 * @param xfer The file transfer. | 327 * @param xfer The file transfer. |
329 * @param fnc The read function. | 328 * @param fnc The read function. |
330 */ | 329 */ |
331 void gaim_xfer_set_read_fnc(struct gaim_xfer *xfer, | 330 void gaim_xfer_set_read_fnc(GaimXfer *xfer, |
332 size_t (*fnc)(char **, struct gaim_xfer *)); | 331 size_t (*fnc)(char **, GaimXfer *)); |
333 | 332 |
334 /** | 333 /** |
335 * Sets the write function for the file transfer. | 334 * Sets the write function for the file transfer. |
336 * | 335 * |
337 * @param xfer The file transfer. | 336 * @param xfer The file transfer. |
338 * @param fnc The write function. | 337 * @param fnc The write function. |
339 */ | 338 */ |
340 void gaim_xfer_set_write_fnc(struct gaim_xfer *xfer, | 339 void gaim_xfer_set_write_fnc(GaimXfer *xfer, |
341 size_t (*fnc)(const char *, size_t, struct gaim_xfer *)); | 340 size_t (*fnc)(const char *, size_t, GaimXfer *)); |
342 | 341 |
343 /** | 342 /** |
344 * Sets the acknowledge function for the file transfer. | 343 * Sets the acknowledge function for the file transfer. |
345 * | 344 * |
346 * @param xfer The file transfer. | 345 * @param xfer The file transfer. |
347 * @param fnc The acknowledge function. | 346 * @param fnc The acknowledge function. |
348 */ | 347 */ |
349 void gaim_xfer_set_ack_fnc(struct gaim_xfer *xfer, | 348 void gaim_xfer_set_ack_fnc(GaimXfer *xfer, |
350 void (*fnc)(struct gaim_xfer *, const char *, size_t)); | 349 void (*fnc)(GaimXfer *, const char *, size_t)); |
351 | 350 |
352 /** | 351 /** |
353 * Sets the transfer initialization function for the file transfer. | 352 * Sets the transfer initialization function for the file transfer. |
354 * | 353 * |
355 * This function is required, and must call gaim_xfer_start() with | 354 * This function is required, and must call gaim_xfer_start() with |
357 * is accepted by the user. | 356 * is accepted by the user. |
358 * | 357 * |
359 * @param xfer The file transfer. | 358 * @param xfer The file transfer. |
360 * @param fnc The transfer initialization function. | 359 * @param fnc The transfer initialization function. |
361 */ | 360 */ |
362 void gaim_xfer_set_init_fnc(struct gaim_xfer *xfer, | 361 void gaim_xfer_set_init_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); |
363 void (*fnc)(struct gaim_xfer *)); | |
364 | 362 |
365 /** | 363 /** |
366 * Sets the start transfer function for the file transfer. | 364 * Sets the start transfer function for the file transfer. |
367 * | 365 * |
368 * @param xfer The file transfer. | 366 * @param xfer The file transfer. |
369 * @param fnc The start transfer function. | 367 * @param fnc The start transfer function. |
370 */ | 368 */ |
371 void gaim_xfer_set_start_fnc(struct gaim_xfer *xfer, | 369 void gaim_xfer_set_start_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); |
372 void (*fnc)(struct gaim_xfer *)); | |
373 | 370 |
374 /** | 371 /** |
375 * Sets the end transfer function for the file transfer. | 372 * Sets the end transfer function for the file transfer. |
376 * | 373 * |
377 * @param xfer The file transfer. | 374 * @param xfer The file transfer. |
378 * @param fnc The end transfer function. | 375 * @param fnc The end transfer function. |
379 */ | 376 */ |
380 void gaim_xfer_set_end_fnc(struct gaim_xfer *xfer, | 377 void gaim_xfer_set_end_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); |
381 void (*fnc)(struct gaim_xfer *)); | |
382 | 378 |
383 /** | 379 /** |
384 * Sets the cancel send function for the file transfer. | 380 * Sets the cancel send function for the file transfer. |
385 * | 381 * |
386 * @param xfer The file transfer. | 382 * @param xfer The file transfer. |
387 * @param fnc The cancel send function. | 383 * @param fnc The cancel send function. |
388 */ | 384 */ |
389 void gaim_xfer_set_cancel_send_fnc(struct gaim_xfer *xfer, | 385 void gaim_xfer_set_cancel_send_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); |
390 void (*fnc)(struct gaim_xfer *)); | |
391 | 386 |
392 /** | 387 /** |
393 * Sets the cancel receive function for the file transfer. | 388 * Sets the cancel receive function for the file transfer. |
394 * | 389 * |
395 * @param xfer The file transfer. | 390 * @param xfer The file transfer. |
396 * @param fnc The cancel receive function. | 391 * @param fnc The cancel receive function. |
397 */ | 392 */ |
398 void gaim_xfer_set_cancel_recv_fnc(struct gaim_xfer *xfer, | 393 void gaim_xfer_set_cancel_recv_fnc(GaimXfer *xfer, void (*fnc)(GaimXfer *)); |
399 void (*fnc)(struct gaim_xfer *)); | |
400 | 394 |
401 /** | 395 /** |
402 * Reads in data from a file transfer stream. | 396 * Reads in data from a file transfer stream. |
403 * | 397 * |
404 * @param xfer The file transfer. | 398 * @param xfer The file transfer. |
405 * @param buffer The buffer that will be created to contain the data. | 399 * @param buffer The buffer that will be created to contain the data. |
406 * | 400 * |
407 * @return The number of bytes read. | 401 * @return The number of bytes read. |
408 */ | 402 */ |
409 size_t gaim_xfer_read(struct gaim_xfer *xfer, char **buffer); | 403 size_t gaim_xfer_read(GaimXfer *xfer, char **buffer); |
410 | 404 |
411 /** | 405 /** |
412 * Writes data to a file transfer stream. | 406 * Writes data to a file transfer stream. |
413 * | 407 * |
414 * @param xfer The file transfer. | 408 * @param xfer The file transfer. |
415 * @param buffer The buffer to read the data from. | 409 * @param buffer The buffer to read the data from. |
416 * @param size The number of bytes to write. | 410 * @param size The number of bytes to write. |
417 * | 411 * |
418 * @return The number of bytes written. | 412 * @return The number of bytes written. |
419 */ | 413 */ |
420 size_t gaim_xfer_write(struct gaim_xfer *xfer, const char *buffer, | 414 size_t gaim_xfer_write(GaimXfer *xfer, const char *buffer, size_t size); |
421 size_t size); | |
422 | 415 |
423 /** | 416 /** |
424 * Starts a file transfer. | 417 * Starts a file transfer. |
425 * | 418 * |
426 * Either @a fd must be specified <i>or</i> @a ip and @a port on a | 419 * Either @a fd must be specified <i>or</i> @a ip and @a port on a |
430 * @param xfer The file transfer. | 423 * @param xfer The file transfer. |
431 * @param fd The file descriptor for the socket. | 424 * @param fd The file descriptor for the socket. |
432 * @param ip The IP address to connect to. | 425 * @param ip The IP address to connect to. |
433 * @param port The port to connect to. | 426 * @param port The port to connect to. |
434 */ | 427 */ |
435 void gaim_xfer_start(struct gaim_xfer *xfer, int fd, const char *ip, | 428 void gaim_xfer_start(GaimXfer *xfer, int fd, const char *ip, |
436 unsigned int port); | 429 unsigned int port); |
437 | 430 |
438 /** | 431 /** |
439 * Ends a file transfer. | 432 * Ends a file transfer. |
440 * | 433 * |
441 * @param xfer The file transfer. | 434 * @param xfer The file transfer. |
442 */ | 435 */ |
443 void gaim_xfer_end(struct gaim_xfer *xfer); | 436 void gaim_xfer_end(GaimXfer *xfer); |
444 | 437 |
445 /** | 438 /** |
446 * Cancels a file transfer on the local end. | 439 * Cancels a file transfer on the local end. |
447 * | 440 * |
448 * @param xfer The file transfer. | 441 * @param xfer The file transfer. |
449 */ | 442 */ |
450 void gaim_xfer_cancel_local(struct gaim_xfer *xfer); | 443 void gaim_xfer_cancel_local(GaimXfer *xfer); |
451 | 444 |
452 /** | 445 /** |
453 * Cancels a file transfer from the remote end. | 446 * Cancels a file transfer from the remote end. |
454 * | 447 * |
455 * @param xfer The file transfer. | 448 * @param xfer The file transfer. |
456 */ | 449 */ |
457 void gaim_xfer_cancel_remote(struct gaim_xfer *xfer); | 450 void gaim_xfer_cancel_remote(GaimXfer *xfer); |
458 | 451 |
459 /** | 452 /** |
460 * Displays a file transfer-related error message. | 453 * Displays a file transfer-related error message. |
461 * | 454 * |
462 * This is a wrapper around gaim_notify_error(), which automatically | 455 * This is a wrapper around gaim_notify_error(), which automatically |
479 /** | 472 /** |
480 * Sets the UI operations structure to be used in all gaim file transfers. | 473 * Sets the UI operations structure to be used in all gaim file transfers. |
481 * | 474 * |
482 * @param fnc The function. | 475 * @param fnc The function. |
483 */ | 476 */ |
484 void gaim_set_xfer_ui_ops(struct gaim_xfer_ui_ops *ops); | 477 void gaim_set_xfer_ui_ops(GaimXferUiOps *ops); |
485 | 478 |
486 /** | 479 /** |
487 * Returns the UI operations structure to be used in all gaim file transfers. | 480 * Returns the UI operations structure to be used in all gaim file transfers. |
488 * | 481 * |
489 * @return The UI operations structure. | 482 * @return The UI operations structure. |
490 */ | 483 */ |
491 struct gaim_xfer_ui_ops *gaim_get_xfer_ui_ops(void); | 484 GaimXferUiOps *gaim_get_xfer_ui_ops(void); |
492 | 485 |
493 /*@}*/ | 486 /*@}*/ |
494 | 487 |
495 #ifdef __cplusplus | 488 #ifdef __cplusplus |
496 } | 489 } |