libpurple/xfer.h

Sun, 06 Oct 2013 18:15:19 +0530

author
Ankit Vani <a@nevitus.org>
date
Sun, 06 Oct 2013 18:15:19 +0530
branch
soc.2013.gobjectification.plugins
changeset 36858
920cf8db7c68
parent 36710
16a60fe59d22
parent 35001
85144a4a7942
child 36896
3865997e388b
permissions
-rw-r--r--

Merged soc.2013.gobjectification branch

4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 /**
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
2 * @file xfer.h File Transfer API
5034
077678f7b048 [gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents: 4675
diff changeset
3 * @ingroup core
20889
3d0ef192f98c All the links to libpurple signal pages were in the comment containing the
Will Thompson <resiak@pidgin.im>
parents: 20147
diff changeset
4 * @see @ref xfer-signals
20147
66f05a854eee applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents: 19859
diff changeset
5 */
66f05a854eee applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents: 19859
diff changeset
6
66f05a854eee applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents: 19859
diff changeset
7 /* purple
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
8 *
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
9 * Purple is the legal property of its developers, whose names are too numerous
8046
c581b20a47d6 [gaim-migrate @ 8730]
Sean Egan <seanegan@pidgin.im>
parents: 7887
diff changeset
10 * to list here. Please refer to the COPYRIGHT file distributed with this
c581b20a47d6 [gaim-migrate @ 8730]
Sean Egan <seanegan@pidgin.im>
parents: 7887
diff changeset
11 * source distribution.
8231
347c8992c445 [gaim-migrate @ 8954]
Tim Ringenbach <marv@pidgin.im>
parents: 8211
diff changeset
12 *
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13 * This program is free software; you can redistribute it and/or modify
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 * it under the terms of the GNU General Public License as published by
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15 * the Free Software Foundation; either version 2 of the License, or
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 * (at your option) any later version.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 * This program is distributed in the hope that it will be useful,
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 * GNU General Public License for more details.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 * You should have received a copy of the GNU General Public License
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 * along with this program; if not, write to the Free Software
19859
71d37b57eff2 The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 17852
diff changeset
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 */
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
27 #ifndef _PURPLE_XFER_H_
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
28 #define _PURPLE_XFER_H_
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
30 #define PURPLE_TYPE_XFER (purple_xfer_get_type())
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
31 #define PURPLE_XFER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_XFER, PurpleXfer))
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
32 #define PURPLE_XFER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_XFER, PurpleXferClass))
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
33 #define PURPLE_IS_XFER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_XFER))
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
34 #define PURPLE_IS_XFER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_XFER))
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
35 #define PURPLE_XFER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_XFER, PurpleXferClass))
34792
09228ea79272 Added GBoxed to certificate, certificate pool, xfer, log
Ankit Vani <a@nevitus.org>
parents: 33465
diff changeset
36
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
37 /**************************************************************************/
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
38 /** Data Structures */
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
39 /**************************************************************************/
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
40 /** @copydoc _PurpleXfer */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
41 typedef struct _PurpleXfer PurpleXfer;
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
42 /** @copydoc _PurpleXferClass */
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
43 typedef struct _PurpleXferClass PurpleXferClass;
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
44
12151
8002bb57756b [gaim-migrate @ 14452]
Richard Laager <rlaager@pidgin.im>
parents: 12150
diff changeset
45 #include <glib.h>
8002bb57756b [gaim-migrate @ 14452]
Richard Laager <rlaager@pidgin.im>
parents: 12150
diff changeset
46 #include <stdio.h>
8002bb57756b [gaim-migrate @ 14452]
Richard Laager <rlaager@pidgin.im>
parents: 12150
diff changeset
47
5872
754c63f29b77 [gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents: 5563
diff changeset
48 #include "account.h"
754c63f29b77 [gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents: 5563
diff changeset
49
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
50 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
51 * Types of file transfers.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
52 */
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
53 typedef enum
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
54 {
34926
c5b444d1447d Changed prefix of PurpleXferType enums to PURPLE_XFER_TYPE_*
Ankit Vani <a@nevitus.org>
parents: 34924
diff changeset
55 PURPLE_XFER_TYPE_UNKNOWN = 0, /**< Unknown file transfer type. */
c5b444d1447d Changed prefix of PurpleXferType enums to PURPLE_XFER_TYPE_*
Ankit Vani <a@nevitus.org>
parents: 34924
diff changeset
56 PURPLE_XFER_TYPE_SEND, /**< File sending. */
c5b444d1447d Changed prefix of PurpleXferType enums to PURPLE_XFER_TYPE_*
Ankit Vani <a@nevitus.org>
parents: 34924
diff changeset
57 PURPLE_XFER_TYPE_RECEIVE /**< File receiving. */
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
58
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
59 } PurpleXferType;
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60
7805
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
61 /**
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
62 * The different states of the xfer.
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
63 */
7738
ebb766ef2146 [gaim-migrate @ 8383]
Tim Ringenbach <marv@pidgin.im>
parents: 7035
diff changeset
64 typedef enum
ebb766ef2146 [gaim-migrate @ 8383]
Tim Ringenbach <marv@pidgin.im>
parents: 7035
diff changeset
65 {
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
66 PURPLE_XFER_STATUS_UNKNOWN = 0, /**< Unknown, the xfer may be null. */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
67 PURPLE_XFER_STATUS_NOT_STARTED, /**< It hasn't started yet. */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
68 PURPLE_XFER_STATUS_ACCEPTED, /**< Receive accepted, but destination file not selected yet */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
69 PURPLE_XFER_STATUS_STARTED, /**< purple_xfer_start has been called. */
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
70 PURPLE_XFER_STATUS_DONE, /**< The xfer completed successfully. */
30708
535bec1e66fb Standardize on "cancelled".
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 30131
diff changeset
71 PURPLE_XFER_STATUS_CANCEL_LOCAL, /**< The xfer was cancelled by us. */
535bec1e66fb Standardize on "cancelled".
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 30131
diff changeset
72 PURPLE_XFER_STATUS_CANCEL_REMOTE /**< The xfer was cancelled by the other end, or we couldn't connect. */
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
73 } PurpleXferStatus;
7738
ebb766ef2146 [gaim-migrate @ 8383]
Tim Ringenbach <marv@pidgin.im>
parents: 7035
diff changeset
74
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
75 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
76 * File transfer UI operations.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
77 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
78 * Any UI representing a file transfer must assign a filled-out
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
79 * PurpleXferUiOps structure to the purple_xfer.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
80 */
6240
0390b27fe09d [gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents: 5944
diff changeset
81 typedef struct
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
82 {
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
83 void (*new_xfer)(PurpleXfer *xfer);
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
84 void (*destroy)(PurpleXfer *xfer);
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
85 void (*add_xfer)(PurpleXfer *xfer);
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
86 void (*update_progress)(PurpleXfer *xfer, double percent);
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
87 void (*cancel_local)(PurpleXfer *xfer);
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
88 void (*cancel_remote)(PurpleXfer *xfer);
6240
0390b27fe09d [gaim-migrate @ 6734]
Christian Hammond <chipx86@chipx86.com>
parents: 5944
diff changeset
89
28150
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
90 /**
36637
9b0109ae118d Renamed some prpl stuff to protocol stuff.
Ankit Vani <a@nevitus.org>
parents: 36545
diff changeset
91 * UI op to write data received from the protocol. The UI must deal with the
28150
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
92 * entire buffer and return size, or it is treated as an error.
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
93 *
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
94 * @param xfer The file transfer structure
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
95 * @param buffer The buffer to write
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
96 * @param size The size of the buffer
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
97 *
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
98 * @return size if the write was successful, or a value between 0 and
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
99 * size on error.
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
100 */
28159
567c6a03a6ea Fix building on win32, which has #define write wpurple_write (and similar for read).
Paul Aurich <darkrain42@pidgin.im>
parents: 28156
diff changeset
101 gssize (*ui_write)(PurpleXfer *xfer, const guchar *buffer, gssize size);
28150
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
102
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
103 /**
36637
9b0109ae118d Renamed some prpl stuff to protocol stuff.
Ankit Vani <a@nevitus.org>
parents: 36545
diff changeset
104 * UI op to read data to send to the protocol for a file transfer.
28150
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
105 *
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
106 * @param xfer The file transfer structure
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
107 * @param buffer A pointer to a buffer. The UI must allocate this buffer.
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
108 * libpurple will free the data.
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
109 * @param size The maximum amount of data to put in the buffer.
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
110 *
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
111 * @returns The amount of data in the buffer, 0 if nothing is available,
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
112 * and a negative value if an error occurred and the transfer
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
113 * should be cancelled (libpurple will cancel).
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
114 */
28159
567c6a03a6ea Fix building on win32, which has #define write wpurple_write (and similar for read).
Paul Aurich <darkrain42@pidgin.im>
parents: 28156
diff changeset
115 gssize (*ui_read)(PurpleXfer *xfer, guchar **buffer, gssize size);
28150
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
116
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
117 /**
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
118 * Op to notify the UI that not all the data read in was written. The UI
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
119 * should re-enqueue this data and return it the next time read is called.
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
120 *
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
121 * This MUST be implemented if read and write are implemented.
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
122 *
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
123 * @param xfer The file transfer structure
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
124 * @param buffer A pointer to the beginning of the unwritten data.
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
125 * @param size The amount of unwritten data.
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
126 */
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
127 void (*data_not_sent)(PurpleXfer *xfer, const guchar *buffer, gsize size);
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
128
28683
2fda587fb3e6 Add a comment about the add thumbnail op for PurpleXfer
Marcus Lundblad <malu@pidgin.im>
parents: 28263
diff changeset
129 /**
2fda587fb3e6 Add a comment about the add thumbnail op for PurpleXfer
Marcus Lundblad <malu@pidgin.im>
parents: 28263
diff changeset
130 * Op to create a thumbnail image for a file transfer
2fda587fb3e6 Add a comment about the add thumbnail op for PurpleXfer
Marcus Lundblad <malu@pidgin.im>
parents: 28263
diff changeset
131 *
2fda587fb3e6 Add a comment about the add thumbnail op for PurpleXfer
Marcus Lundblad <malu@pidgin.im>
parents: 28263
diff changeset
132 * @param xfer The file transfer structure
2fda587fb3e6 Add a comment about the add thumbnail op for PurpleXfer
Marcus Lundblad <malu@pidgin.im>
parents: 28263
diff changeset
133 */
30114
8472e53fbbfc Set desired image formats for thumbnails as a parameter to
Marcus Lundblad <malu@pidgin.im>
parents: 30113
diff changeset
134 void (*add_thumbnail)(PurpleXfer *xfer, const gchar *formats);
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
135 } PurpleXferUiOps;
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
136
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
137 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
138 * A core representation of a file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
139 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
140 struct _PurpleXfer
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
141 {
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
142 /*< private >*/
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
143 GObject gparent;
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
144
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
145 /** The UI data associated with this file transfer. This is a convenience
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
146 * field provided to the UIs -- it is not used by the libpurple core.
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
147 */
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
148 gpointer ui_data;
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
149 };
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
150
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
151 /** Base class for all #PurpleXfer's */
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
152 struct _PurpleXferClass
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
153 {
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
154 /*< private >*/
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
155 GObjectClass parent_class;
4538
929fb97f4e7f [gaim-migrate @ 4817]
Nathan Walp <nwalp@pidgin.im>
parents: 4518
diff changeset
156
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
157 void (*_purple_reserved1)(void);
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
158 void (*_purple_reserved2)(void);
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
159 void (*_purple_reserved3)(void);
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
160 void (*_purple_reserved4)(void);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
161 };
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
162
32787
7072f190d6ad Use G_BEGIN/END_DECLS in public libpurple files. This was
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32663
diff changeset
163 G_BEGIN_DECLS
5944
f19df037ac58 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5872
diff changeset
164
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
165 /**************************************************************************/
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
166 /** @name File Transfer API */
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
167 /**************************************************************************/
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
168 /*@{*/
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
169
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
170 /**
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
171 * Returns the GType for the PurpleXfer object.
34792
09228ea79272 Added GBoxed to certificate, certificate pool, xfer, log
Ankit Vani <a@nevitus.org>
parents: 33465
diff changeset
172 */
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
173 GType purple_xfer_get_type(void);
34792
09228ea79272 Added GBoxed to certificate, certificate pool, xfer, log
Ankit Vani <a@nevitus.org>
parents: 33465
diff changeset
174
09228ea79272 Added GBoxed to certificate, certificate pool, xfer, log
Ankit Vani <a@nevitus.org>
parents: 33465
diff changeset
175 /**
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
176 * Creates a new file transfer handle.
36637
9b0109ae118d Renamed some prpl stuff to protocol stuff.
Ankit Vani <a@nevitus.org>
parents: 36545
diff changeset
177 * This is called by protocols.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
178 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
179 * @param account The account sending or receiving the file.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
180 * @param type The type of file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
181 * @param who The name of the remote user.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
182 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
183 * @return A file transfer handle.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
184 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
185 PurpleXfer *purple_xfer_new(PurpleAccount *account,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
186 PurpleXferType type, const char *who);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
187
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
188 /**
8585
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
189 * Requests confirmation for a file transfer from the user. If receiving
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
190 * a file which is known at this point, this requests user to accept and
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
191 * save the file. If the filename is unknown (not set) this only requests user
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
192 * to accept the file transfer. In this case protocol must call this function
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
193 * again once the filename is available.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
194 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
195 * @param xfer The file transfer to request confirmation on.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
196 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
197 void purple_xfer_request(PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
198
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
199 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
200 * Called if the user accepts the file transfer request.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
201 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
202 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
203 * @param filename The filename.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
204 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
205 void purple_xfer_request_accepted(PurpleXfer *xfer, const char *filename);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
206
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
207 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
208 * Called if the user rejects the file transfer request.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
209 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
210 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
211 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
212 void purple_xfer_request_denied(PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
213
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
214 /**
32289
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
215 * Returns the socket file descriptor.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
216 *
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
217 * @param xfer The file transfer.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
218 *
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
219 * @return The socket file descriptor.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
220 */
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
221 int purple_xfer_get_fd(PurpleXfer *xfer);
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
222
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
223 /**
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
224 * Returns the Watcher for the transfer.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
225 *
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
226 * @param xfer The file transfer.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
227 *
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
228 * @return The watcher.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
229 */
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
230 int purple_xfer_get_watcher(PurpleXfer *xfer);
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
231
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
232 /**
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
233 * Returns the type of file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
234 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
235 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
236 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
237 * @return The type of the file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
238 */
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
239 PurpleXferType purple_xfer_get_xfer_type(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
240
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
241 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
242 * Returns the account the file transfer is using.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
243 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
244 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
245 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
246 * @return The account.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
247 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
248 PurpleAccount *purple_xfer_get_account(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
249
34922
6043d2b7f55a Started GObjectification of xfer.c
Ankit Vani <a@nevitus.org>
parents: 34919
diff changeset
250 /**
34913
21017b84a070 Refactored jabber to use the GObject xfer API.
Ankit Vani <a@nevitus.org>
parents: 34912
diff changeset
251 * Sets the name of the remote user.
21017b84a070 Refactored jabber to use the GObject xfer API.
Ankit Vani <a@nevitus.org>
parents: 34912
diff changeset
252 *
21017b84a070 Refactored jabber to use the GObject xfer API.
Ankit Vani <a@nevitus.org>
parents: 34912
diff changeset
253 * @param xfer The file transfer.
21017b84a070 Refactored jabber to use the GObject xfer API.
Ankit Vani <a@nevitus.org>
parents: 34912
diff changeset
254 * @param who The name of the remote user.
21017b84a070 Refactored jabber to use the GObject xfer API.
Ankit Vani <a@nevitus.org>
parents: 34912
diff changeset
255 */
21017b84a070 Refactored jabber to use the GObject xfer API.
Ankit Vani <a@nevitus.org>
parents: 34912
diff changeset
256 void purple_xfer_set_remote_user(PurpleXfer *xfer, const char *who);
21017b84a070 Refactored jabber to use the GObject xfer API.
Ankit Vani <a@nevitus.org>
parents: 34912
diff changeset
257
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
258 /**
17852
174c0d122a79 Add new function purple_xfer_get_remote_user.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16743
diff changeset
259 * Returns the name of the remote user.
174c0d122a79 Add new function purple_xfer_get_remote_user.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16743
diff changeset
260 *
174c0d122a79 Add new function purple_xfer_get_remote_user.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16743
diff changeset
261 * @param xfer The file transfer.
174c0d122a79 Add new function purple_xfer_get_remote_user.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16743
diff changeset
262 *
174c0d122a79 Add new function purple_xfer_get_remote_user.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16743
diff changeset
263 * @return The name of the remote user.
174c0d122a79 Add new function purple_xfer_get_remote_user.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16743
diff changeset
264 */
174c0d122a79 Add new function purple_xfer_get_remote_user.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16743
diff changeset
265 const char *purple_xfer_get_remote_user(const PurpleXfer *xfer);
174c0d122a79 Add new function purple_xfer_get_remote_user.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16743
diff changeset
266
174c0d122a79 Add new function purple_xfer_get_remote_user.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 16743
diff changeset
267 /**
7805
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
268 * Returns the status of the xfer.
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
269 *
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
270 * @param xfer The file transfer.
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
271 *
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
272 * @return The status.
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
273 */
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
274 PurpleXferStatus purple_xfer_get_status(const PurpleXfer *xfer);
7805
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
275
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
276 /**
30708
535bec1e66fb Standardize on "cancelled".
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 30131
diff changeset
277 * Returns true if the file transfer was cancelled.
7738
ebb766ef2146 [gaim-migrate @ 8383]
Tim Ringenbach <marv@pidgin.im>
parents: 7035
diff changeset
278 *
ebb766ef2146 [gaim-migrate @ 8383]
Tim Ringenbach <marv@pidgin.im>
parents: 7035
diff changeset
279 * @param xfer The file transfer.
ebb766ef2146 [gaim-migrate @ 8383]
Tim Ringenbach <marv@pidgin.im>
parents: 7035
diff changeset
280 *
30708
535bec1e66fb Standardize on "cancelled".
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 30131
diff changeset
281 * @return Whether or not the transfer was cancelled.
7738
ebb766ef2146 [gaim-migrate @ 8383]
Tim Ringenbach <marv@pidgin.im>
parents: 7035
diff changeset
282 */
32607
3d50780413f8 purple_xfer_is_canceled() renamed to purple_xfer_is_cancelled()
Andrew Victor <andrew.victor@mxit.com>
parents: 32604
diff changeset
283 gboolean purple_xfer_is_cancelled(const PurpleXfer *xfer);
7738
ebb766ef2146 [gaim-migrate @ 8383]
Tim Ringenbach <marv@pidgin.im>
parents: 7035
diff changeset
284
ebb766ef2146 [gaim-migrate @ 8383]
Tim Ringenbach <marv@pidgin.im>
parents: 7035
diff changeset
285 /**
4539
44671e1ce14e [gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents: 4538
diff changeset
286 * Returns the completed state for a file transfer.
44671e1ce14e [gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents: 4538
diff changeset
287 *
44671e1ce14e [gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents: 4538
diff changeset
288 * @param xfer The file transfer.
44671e1ce14e [gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents: 4538
diff changeset
289 *
44671e1ce14e [gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents: 4538
diff changeset
290 * @return The completed state.
44671e1ce14e [gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents: 4538
diff changeset
291 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
292 gboolean purple_xfer_is_completed(const PurpleXfer *xfer);
4539
44671e1ce14e [gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents: 4538
diff changeset
293
44671e1ce14e [gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents: 4538
diff changeset
294 /**
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
295 * Returns the name of the file being sent or received.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
296 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
297 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
298 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
299 * @return The filename.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
300 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
301 const char *purple_xfer_get_filename(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
302
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
303 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
304 * Returns the file's destination filename,
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
305 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
306 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
307 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
308 * @return The destination filename.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
309 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
310 const char *purple_xfer_get_local_filename(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
311
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
312 /**
13009
12ef9f229961 [gaim-migrate @ 15362]
Daniel Atallah <datallah@pidgin.im>
parents: 12151
diff changeset
313 * Returns the number of bytes sent (or received) so far.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
314 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
315 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
316 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
317 * @return The number of bytes sent.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
318 */
32663
1b87b3e98b0a Upgrade PurpleXfer for a 64-bit world.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32608
diff changeset
319 goffset purple_xfer_get_bytes_sent(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
320
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
321 /**
13009
12ef9f229961 [gaim-migrate @ 15362]
Daniel Atallah <datallah@pidgin.im>
parents: 12151
diff changeset
322 * Returns the number of bytes remaining to send or receive.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
323 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
324 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
325 *
13009
12ef9f229961 [gaim-migrate @ 15362]
Daniel Atallah <datallah@pidgin.im>
parents: 12151
diff changeset
326 * @return The number of bytes remaining.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
327 */
32663
1b87b3e98b0a Upgrade PurpleXfer for a 64-bit world.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32608
diff changeset
328 goffset purple_xfer_get_bytes_remaining(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
329
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
330 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
331 * Returns the size of the file being sent or received.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
332 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
333 * @param xfer The file transfer.
7805
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
334 *
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
335 * @return The total size of the file.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
336 */
32663
1b87b3e98b0a Upgrade PurpleXfer for a 64-bit world.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32608
diff changeset
337 goffset purple_xfer_get_size(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
338
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
339 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
340 * Returns the current percentage of progress of the transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
341 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
342 * This is a number between 0 (0%) and 1 (100%).
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
343 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
344 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
345 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
346 * @return The percentage complete.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
347 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
348 double purple_xfer_get_progress(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
349
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
350 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
351 * Returns the local port number in the file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
352 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
353 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
354 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
355 * @return The port number on this end.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
356 */
34457
a9d3726c3a8f Clang warnings: clean up libpurple
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34286
diff changeset
357 guint16 purple_xfer_get_local_port(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
358
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
359 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
360 * Returns the remote IP address in the file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
361 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
362 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
363 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
364 * @return The IP address on the other end.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
365 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
366 const char *purple_xfer_get_remote_ip(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
367
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
368 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
369 * Returns the remote port number in the file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
370 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
371 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
372 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
373 * @return The port number on the other end.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
374 */
34457
a9d3726c3a8f Clang warnings: clean up libpurple
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34286
diff changeset
375 guint16 purple_xfer_get_remote_port(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
376
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
377 /**
22338
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
378 * Returns the time the transfer of a file started.
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
379 *
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
380 * @param xfer The file transfer.
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
381 *
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
382 * @return The time when the transfer started.
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
383 */
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
384 time_t purple_xfer_get_start_time(const PurpleXfer *xfer);
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
385
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
386 /**
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
387 * Returns the time the transfer of a file ended.
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
388 *
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
389 * @param xfer The file transfer.
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
390 *
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
391 * @return The time when the transfer ended.
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
392 */
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
393 time_t purple_xfer_get_end_time(const PurpleXfer *xfer);
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
394
d6a489105624 Add accessor and update finch to not touch the internals of PurpleXfer.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 20940
diff changeset
395 /**
32289
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
396 * Sets the socket file descriptor.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
397 *
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
398 * @param xfer The file transfer.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
399 * @param fd The file descriptor.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
400 */
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
401 void purple_xfer_set_fd(PurpleXfer *xfer, int fd);
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
402
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
403 /**
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
404 * Sets the watcher for the file transfer.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
405 *
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
406 * @param xfer The file transfer.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
407 * @param watcher The watcher.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
408 */
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
409 void purple_xfer_set_watcher(PurpleXfer *xfer, int watcher);
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
410
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
411 /**
4538
929fb97f4e7f [gaim-migrate @ 4817]
Nathan Walp <nwalp@pidgin.im>
parents: 4518
diff changeset
412 * Sets the completed state for the file transfer.
929fb97f4e7f [gaim-migrate @ 4817]
Nathan Walp <nwalp@pidgin.im>
parents: 4518
diff changeset
413 *
929fb97f4e7f [gaim-migrate @ 4817]
Nathan Walp <nwalp@pidgin.im>
parents: 4518
diff changeset
414 * @param xfer The file transfer.
929fb97f4e7f [gaim-migrate @ 4817]
Nathan Walp <nwalp@pidgin.im>
parents: 4518
diff changeset
415 * @param completed The completed state.
929fb97f4e7f [gaim-migrate @ 4817]
Nathan Walp <nwalp@pidgin.im>
parents: 4518
diff changeset
416 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
417 void purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed);
4538
929fb97f4e7f [gaim-migrate @ 4817]
Nathan Walp <nwalp@pidgin.im>
parents: 4518
diff changeset
418
929fb97f4e7f [gaim-migrate @ 4817]
Nathan Walp <nwalp@pidgin.im>
parents: 4518
diff changeset
419 /**
32289
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
420 * Sets the current status for the file transfer.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
421 *
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
422 * @param xfer The file transfer.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
423 * @param status The current status.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
424 */
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
425 void purple_xfer_set_status(PurpleXfer *xfer, PurpleXferStatus status);
32289
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
426
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
427 /**
34924
a8e724fe164e Fixed an incorrect documentation
Ankit Vani <a@nevitus.org>
parents: 34922
diff changeset
428 * Sets the message for the file transfer.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
429 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
430 * @param xfer The file transfer.
9933
61bd3fadbfe6 [gaim-migrate @ 10825]
Dave West <kat@users.sourceforge.net>
parents: 9511
diff changeset
431 * @param message The message.
61bd3fadbfe6 [gaim-migrate @ 10825]
Dave West <kat@users.sourceforge.net>
parents: 9511
diff changeset
432 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
433 void purple_xfer_set_message(PurpleXfer *xfer, const char *message);
9933
61bd3fadbfe6 [gaim-migrate @ 10825]
Dave West <kat@users.sourceforge.net>
parents: 9511
diff changeset
434
61bd3fadbfe6 [gaim-migrate @ 10825]
Dave West <kat@users.sourceforge.net>
parents: 9511
diff changeset
435 /**
34927
cef809309dbf Fixed libpurple build errors, and added purple_xfer_get_message()
Ankit Vani <a@nevitus.org>
parents: 34926
diff changeset
436 * Returns the message for the file transfer.
cef809309dbf Fixed libpurple build errors, and added purple_xfer_get_message()
Ankit Vani <a@nevitus.org>
parents: 34926
diff changeset
437 *
cef809309dbf Fixed libpurple build errors, and added purple_xfer_get_message()
Ankit Vani <a@nevitus.org>
parents: 34926
diff changeset
438 * @param xfer The file transfer.
cef809309dbf Fixed libpurple build errors, and added purple_xfer_get_message()
Ankit Vani <a@nevitus.org>
parents: 34926
diff changeset
439 *
cef809309dbf Fixed libpurple build errors, and added purple_xfer_get_message()
Ankit Vani <a@nevitus.org>
parents: 34926
diff changeset
440 * @return The message.
cef809309dbf Fixed libpurple build errors, and added purple_xfer_get_message()
Ankit Vani <a@nevitus.org>
parents: 34926
diff changeset
441 */
cef809309dbf Fixed libpurple build errors, and added purple_xfer_get_message()
Ankit Vani <a@nevitus.org>
parents: 34926
diff changeset
442 const char *purple_xfer_get_message(const PurpleXfer *xfer);
cef809309dbf Fixed libpurple build errors, and added purple_xfer_get_message()
Ankit Vani <a@nevitus.org>
parents: 34926
diff changeset
443
cef809309dbf Fixed libpurple build errors, and added purple_xfer_get_message()
Ankit Vani <a@nevitus.org>
parents: 34926
diff changeset
444 /**
9933
61bd3fadbfe6 [gaim-migrate @ 10825]
Dave West <kat@users.sourceforge.net>
parents: 9511
diff changeset
445 * Sets the filename for the file transfer.
61bd3fadbfe6 [gaim-migrate @ 10825]
Dave West <kat@users.sourceforge.net>
parents: 9511
diff changeset
446 *
61bd3fadbfe6 [gaim-migrate @ 10825]
Dave West <kat@users.sourceforge.net>
parents: 9511
diff changeset
447 * @param xfer The file transfer.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
448 * @param filename The filename.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
449 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
450 void purple_xfer_set_filename(PurpleXfer *xfer, const char *filename);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
451
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
452 /**
4605
67526771e679 [gaim-migrate @ 4892]
Mark Doliner <markdoliner@pidgin.im>
parents: 4595
diff changeset
453 * Sets the local filename for the file transfer.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
454 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
455 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
456 * @param filename The filename
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
457 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
458 void purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
459
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
460 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
461 * Sets the size of the file in a file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
462 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
463 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
464 * @param size The size of the file.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
465 */
32663
1b87b3e98b0a Upgrade PurpleXfer for a 64-bit world.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32608
diff changeset
466 void purple_xfer_set_size(PurpleXfer *xfer, goffset size);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
467
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
468 /**
32289
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
469 * Sets the local port of the file transfer.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
470 *
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
471 * @param xfer The file transfer.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
472 * @param local_port The local port.
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
473 */
34457
a9d3726c3a8f Clang warnings: clean up libpurple
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34286
diff changeset
474 void purple_xfer_set_local_port(PurpleXfer *xfer, guint16 local_port);
32289
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
475
8c121b654972 Add some get/set functions to help hidding _PrupleXfer.
Jorge Villaseñor <masca@cpw.pidgin.im>
parents: 32282
diff changeset
476 /**
15322
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
477 * Sets the current working position in the active file transfer. This
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
478 * can be used to jump backward in the file if the protocol detects
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
479 * that some bit of data needs to be resent or has been sent twice.
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
480 *
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
481 * It's used for pausing and resuming an oscar file transfer.
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
482 *
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
483 * @param xfer The file transfer.
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
484 * @param bytes_sent The new current position in the file. If we're
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
485 * sending a file then this is the byte that we will
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
486 * send. If we're receiving a file, this is the
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
487 * next byte that we expect to receive.
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
488 */
32663
1b87b3e98b0a Upgrade PurpleXfer for a 64-bit world.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32608
diff changeset
489 void purple_xfer_set_bytes_sent(PurpleXfer *xfer, goffset bytes_sent);
15322
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
490
cd268e368bc1 [gaim-migrate @ 18050]
Mark Doliner <markdoliner@pidgin.im>
parents: 15280
diff changeset
491 /**
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
492 * Returns the UI operations structure for a file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
493 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
494 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
495 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
496 * @return The UI operations structure.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
497 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
498 PurpleXferUiOps *purple_xfer_get_ui_ops(const PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
499
34919
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
500 /**
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
501 * Sets the read function for the file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
502 *
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
503 * @param xfer The file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
504 * @param fnc The read function.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
505 */
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
506 void purple_xfer_set_read_fnc(PurpleXfer *xfer,
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
507 gssize (*fnc)(guchar **, PurpleXfer *));
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
508
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
509 /**
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
510 * Sets the write function for the file transfer.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
511 *
34919
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
512 * @param xfer The file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
513 * @param fnc The write function.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
514 */
34919
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
515 void purple_xfer_set_write_fnc(PurpleXfer *xfer,
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
516 gssize (*fnc)(const guchar *, size_t, PurpleXfer *));
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
517
34919
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
518 /**
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
519 * Sets the acknowledge function for the file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
520 *
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
521 * @param xfer The file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
522 * @param fnc The acknowledge function.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
523 */
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
524 void purple_xfer_set_ack_fnc(PurpleXfer *xfer,
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
525 void (*fnc)(PurpleXfer *, const guchar *, size_t));
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
526
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
527 /**
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
528 * Sets the function to be called if the request is denied.
7805
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
529 *
6045c467441e [gaim-migrate @ 8452]
Tim Ringenbach <marv@pidgin.im>
parents: 7738
diff changeset
530 * @param xfer The file transfer.
36637
9b0109ae118d Renamed some prpl stuff to protocol stuff.
Ankit Vani <a@nevitus.org>
parents: 36545
diff changeset
531 * @param fnc The request denied protocol callback.
34919
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
532 */
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
533 void purple_xfer_set_request_denied_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
534
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
535 /**
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
536 * Sets the transfer initialization function for the file transfer.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
537 *
34919
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
538 * This function is required, and must call purple_xfer_start() with
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
539 * the necessary parameters. This will be called if the file transfer
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
540 * is accepted by the user.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
541 *
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
542 * @param xfer The file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
543 * @param fnc The transfer initialization function.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
544 */
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
545 void purple_xfer_set_init_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
546
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
547 /**
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
548 * Sets the start transfer function for the file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
549 *
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
550 * @param xfer The file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
551 * @param fnc The start transfer function.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
552 */
34919
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
553 void purple_xfer_set_start_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
554
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
555 /**
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
556 * Sets the end transfer function for the file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
557 *
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
558 * @param xfer The file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
559 * @param fnc The end transfer function.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
560 */
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
561 void purple_xfer_set_end_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
562
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
563 /**
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
564 * Sets the cancel send function for the file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
565 *
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
566 * @param xfer The file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
567 * @param fnc The cancel send function.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
568 */
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
569 void purple_xfer_set_cancel_send_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
570
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
571 /**
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
572 * Sets the cancel receive function for the file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
573 *
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
574 * @param xfer The file transfer.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
575 * @param fnc The cancel receive function.
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
576 */
80d8cc6db8a3 Removed PurpleXferIoOps
Ankit Vani <a@nevitus.org>
parents: 34913
diff changeset
577 void purple_xfer_set_cancel_recv_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
578
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
579 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
580 * Reads in data from a file transfer stream.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
581 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
582 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
583 * @param buffer The buffer that will be created to contain the data.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
584 *
8231
347c8992c445 [gaim-migrate @ 8954]
Tim Ringenbach <marv@pidgin.im>
parents: 8211
diff changeset
585 * @return The number of bytes read, or -1.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
586 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
587 gssize purple_xfer_read(PurpleXfer *xfer, guchar **buffer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
588
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
589 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
590 * Writes data to a file transfer stream.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
591 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
592 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
593 * @param buffer The buffer to read the data from.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
594 * @param size The number of bytes to write.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
595 *
8231
347c8992c445 [gaim-migrate @ 8954]
Tim Ringenbach <marv@pidgin.im>
parents: 8211
diff changeset
596 * @return The number of bytes written, or -1.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
597 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
598 gssize purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
599
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
600 /**
34272
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
601 * Writes chunk of received file.
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
602 *
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
603 * @param xfer The file transfer.
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
604 * @param buffer The buffer to read the data from.
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
605 * @param size The number of bytes to write.
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
606 *
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
607 * @return TRUE on success, FALSE otherwise.
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
608 */
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
609 gboolean
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
610 purple_xfer_write_file(PurpleXfer *xfer, const guchar *buffer, gsize size);
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
611
8df870b218ca HTTP: chop off another HTTP implementation (for xmpp oob file transfers)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 33465
diff changeset
612 /**
34286
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
613 * Writes chunk of file being sent.
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
614 *
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
615 * @param xfer The file transfer.
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
616 * @param buffer The buffer to write the data to.
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
617 * @param size The size of buffer.
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
618 *
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
619 * @return Number of bytes written (0 means, the device is busy), or -1 on
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
620 * failure.
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
621 */
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
622 gssize
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
623 purple_xfer_read_file(PurpleXfer *xfer, guchar *buffer, gsize size);
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
624
8d0979967d05 HTTP: removing extra yahoo HTTP implementations - file transfer (and small improvements to libpurple http and ft code)
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 34272
diff changeset
625 /**
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
626 * Starts a file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
627 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
628 * Either @a fd must be specified <i>or</i> @a ip and @a port on a
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
629 * file receive transfer. On send, @a fd must be specified, and
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
630 * @a ip and @a port are ignored.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
631 *
32608
68c936aba5df Remove the special case of fd=0 in purple_xfer_start().
Andrew Victor <andrew.victor@mxit.com>
parents: 32607
diff changeset
632 * Passing @a fd as '-1' is a special-case and indicates to the
36691
92122af1f083 Some documentation updates with regard to 'protocol plugins' and 'protocols'
Ankit Vani <a@nevitus.org>
parents: 36689
diff changeset
633 * protocol to facilitate the file transfer itself.
28152
e9800c07eb5b ft: Fix a bunch of uses of 0 as an 'invalid' fd.
Paul Aurich <darkrain42@pidgin.im>
parents: 28150
diff changeset
634 *
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
635 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
636 * @param fd The file descriptor for the socket.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
637 * @param ip The IP address to connect to.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
638 * @param port The port to connect to.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
639 */
34457
a9d3726c3a8f Clang warnings: clean up libpurple
Tomasz Wasilczyk <twasilczyk@pidgin.im>
parents: 34286
diff changeset
640 void purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip, guint16 port);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
641
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
642 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
643 * Ends a file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
644 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
645 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
646 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
647 void purple_xfer_end(PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
648
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
649 /**
8585
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
650 * Adds a new file transfer to the list of file transfers. Call this only
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
651 * if you are not using purple_xfer_start.
8585
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
652 *
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
653 * @param xfer The file transfer.
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
654 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
655 void purple_xfer_add(PurpleXfer *xfer);
8585
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
656
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
657 /**
4675
8e0a7b537ca2 [gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents: 4605
diff changeset
658 * Cancels a file transfer on the local end.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
659 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
660 * @param xfer The file transfer.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
661 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
662 void purple_xfer_cancel_local(PurpleXfer *xfer);
4675
8e0a7b537ca2 [gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents: 4605
diff changeset
663
8e0a7b537ca2 [gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents: 4605
diff changeset
664 /**
8e0a7b537ca2 [gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents: 4605
diff changeset
665 * Cancels a file transfer from the remote end.
8e0a7b537ca2 [gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents: 4605
diff changeset
666 *
8e0a7b537ca2 [gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents: 4605
diff changeset
667 * @param xfer The file transfer.
8e0a7b537ca2 [gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents: 4605
diff changeset
668 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
669 void purple_xfer_cancel_remote(PurpleXfer *xfer);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
670
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
671 /**
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
672 * Displays a file transfer-related error message.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
673 *
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
674 * This is a wrapper around purple_notify_error(), which automatically
10654
b2dd3be1b087 [gaim-migrate @ 12182]
Richard Laager <rlaager@pidgin.im>
parents: 9933
diff changeset
675 * specifies a title ("File transfer to <i>user</i> failed" or
b2dd3be1b087 [gaim-migrate @ 12182]
Richard Laager <rlaager@pidgin.im>
parents: 9933
diff changeset
676 * "File Transfer from <i>user</i> failed").
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
677 *
10654
b2dd3be1b087 [gaim-migrate @ 12182]
Richard Laager <rlaager@pidgin.im>
parents: 9933
diff changeset
678 * @param type The type of file transfer.
b2dd3be1b087 [gaim-migrate @ 12182]
Richard Laager <rlaager@pidgin.im>
parents: 9933
diff changeset
679 * @param account The account sending or receiving the file.
b2dd3be1b087 [gaim-migrate @ 12182]
Richard Laager <rlaager@pidgin.im>
parents: 9933
diff changeset
680 * @param who The user on the other end of the transfer.
b2dd3be1b087 [gaim-migrate @ 12182]
Richard Laager <rlaager@pidgin.im>
parents: 9933
diff changeset
681 * @param msg The message to display.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
682 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
683 void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
684
8585
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
685 /**
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
686 * Updates file transfer progress.
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
687 *
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
688 * @param xfer The file transfer.
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
689 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
690 void purple_xfer_update_progress(PurpleXfer *xfer);
8585
23db71a2d432 [gaim-migrate @ 9335]
Pekka Riikonen <priikone@silcnet.org>
parents: 8231
diff changeset
691
11084
b6acee973833 [gaim-migrate @ 13103]
Jonathan Clark <ardentlygnarly@users.sourceforge.net>
parents: 10654
diff changeset
692 /**
b6acee973833 [gaim-migrate @ 13103]
Jonathan Clark <ardentlygnarly@users.sourceforge.net>
parents: 10654
diff changeset
693 * Displays a file transfer-related message in the conversation window
b6acee973833 [gaim-migrate @ 13103]
Jonathan Clark <ardentlygnarly@users.sourceforge.net>
parents: 10654
diff changeset
694 *
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
695 * This is a wrapper around purple_conversation_write
11084
b6acee973833 [gaim-migrate @ 13103]
Jonathan Clark <ardentlygnarly@users.sourceforge.net>
parents: 10654
diff changeset
696 *
b6acee973833 [gaim-migrate @ 13103]
Jonathan Clark <ardentlygnarly@users.sourceforge.net>
parents: 10654
diff changeset
697 * @param xfer The file transfer to which this message relates.
b6acee973833 [gaim-migrate @ 13103]
Jonathan Clark <ardentlygnarly@users.sourceforge.net>
parents: 10654
diff changeset
698 * @param message The message to display.
11129
c986d8566843 [gaim-migrate @ 13185]
Mark Doliner <markdoliner@pidgin.im>
parents: 11084
diff changeset
699 * @param is_error Is this an error message?.
11084
b6acee973833 [gaim-migrate @ 13103]
Jonathan Clark <ardentlygnarly@users.sourceforge.net>
parents: 10654
diff changeset
700 */
33465
215bec3b763a Add const to the API, where needed
Tomasz Wasilczyk <tomkiewicz@cpw.pidgin.im>
parents: 32787
diff changeset
701 void purple_xfer_conversation_write(PurpleXfer *xfer, const gchar *message, gboolean is_error);
11084
b6acee973833 [gaim-migrate @ 13103]
Jonathan Clark <ardentlygnarly@users.sourceforge.net>
parents: 10654
diff changeset
702
28150
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
703 /**
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
704 * Allows the UI to signal it's ready to send/receive data (depending on
28156
0a75e2463576 ft: Add infrastructure to allow a prpl to moderate when to send packets.
Paul Aurich <darkrain42@pidgin.im>
parents: 28152
diff changeset
705 * the direction of the file transfer. Used when the UI is providing
0a75e2463576 ft: Add infrastructure to allow a prpl to moderate when to send packets.
Paul Aurich <darkrain42@pidgin.im>
parents: 28152
diff changeset
706 * read/write/data_not_sent UI ops.
28150
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
707 *
28156
0a75e2463576 ft: Add infrastructure to allow a prpl to moderate when to send packets.
Paul Aurich <darkrain42@pidgin.im>
parents: 28152
diff changeset
708 * @param xfer The file transfer which is ready.
28150
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
709 */
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
710 void purple_xfer_ui_ready(PurpleXfer *xfer);
1213ec1efcf8 ft: Allow the UI to overloadthe use of fread/fwrite. Closes #9844.
Jan Kaluza <hanzz.k@gmail.com>
parents: 22338
diff changeset
711
28156
0a75e2463576 ft: Add infrastructure to allow a prpl to moderate when to send packets.
Paul Aurich <darkrain42@pidgin.im>
parents: 28152
diff changeset
712 /**
36637
9b0109ae118d Renamed some prpl stuff to protocol stuff.
Ankit Vani <a@nevitus.org>
parents: 36545
diff changeset
713 * Allows the protocol to signal it's ready to send/receive data (depending on
9b0109ae118d Renamed some prpl stuff to protocol stuff.
Ankit Vani <a@nevitus.org>
parents: 36545
diff changeset
714 * the direction of the file transfer. Used when the protocol provides read/write
28156
0a75e2463576 ft: Add infrastructure to allow a prpl to moderate when to send packets.
Paul Aurich <darkrain42@pidgin.im>
parents: 28152
diff changeset
715 * ops and cannot/does not provide a raw fd to the core.
0a75e2463576 ft: Add infrastructure to allow a prpl to moderate when to send packets.
Paul Aurich <darkrain42@pidgin.im>
parents: 28152
diff changeset
716 *
0a75e2463576 ft: Add infrastructure to allow a prpl to moderate when to send packets.
Paul Aurich <darkrain42@pidgin.im>
parents: 28152
diff changeset
717 * @param xfer The file transfer which is ready.
0a75e2463576 ft: Add infrastructure to allow a prpl to moderate when to send packets.
Paul Aurich <darkrain42@pidgin.im>
parents: 28152
diff changeset
718 */
36545
23b59a16c808 Replaced some _prpl_ stuff with _protocol_
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
719 void purple_xfer_protocol_ready(PurpleXfer *xfer);
28156
0a75e2463576 ft: Add infrastructure to allow a prpl to moderate when to send packets.
Paul Aurich <darkrain42@pidgin.im>
parents: 28152
diff changeset
720
28263
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
721 /**
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
722 * Gets the thumbnail data for a transfer
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
723 *
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
724 * @param xfer The file transfer to get the thumbnail for
30126
f09ecb81212c Rename purple_xfer_get_thumbnail_data/size to be more D-Bus friendly.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 30115
diff changeset
725 * @param len If not @c NULL, the length of the thumbnail data returned
f09ecb81212c Rename purple_xfer_get_thumbnail_data/size to be more D-Bus friendly.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 30115
diff changeset
726 * will be set in the location pointed to by this.
28263
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
727 * @return The thumbnail data, or NULL if there is no thumbnail
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
728 */
30126
f09ecb81212c Rename purple_xfer_get_thumbnail_data/size to be more D-Bus friendly.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 30115
diff changeset
729 gconstpointer purple_xfer_get_thumbnail(const PurpleXfer *xfer, gsize *len);
28263
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
730
30113
f60cbf3b3ca9 Allow PRPLs to specify the image formats acceptable for thumbnails (in
Marcus Lundblad <malu@pidgin.im>
parents: 29465
diff changeset
731 /**
f60cbf3b3ca9 Allow PRPLs to specify the image formats acceptable for thumbnails (in
Marcus Lundblad <malu@pidgin.im>
parents: 29465
diff changeset
732 * Gets the mimetype of the thumbnail preview for a transfer
f60cbf3b3ca9 Allow PRPLs to specify the image formats acceptable for thumbnails (in
Marcus Lundblad <malu@pidgin.im>
parents: 29465
diff changeset
733 *
f60cbf3b3ca9 Allow PRPLs to specify the image formats acceptable for thumbnails (in
Marcus Lundblad <malu@pidgin.im>
parents: 29465
diff changeset
734 * @param xfer The file transfer to get the mimetype for
f60cbf3b3ca9 Allow PRPLs to specify the image formats acceptable for thumbnails (in
Marcus Lundblad <malu@pidgin.im>
parents: 29465
diff changeset
735 * @return The mimetype of the thumbnail, or @c NULL if not thumbnail is set
f60cbf3b3ca9 Allow PRPLs to specify the image formats acceptable for thumbnails (in
Marcus Lundblad <malu@pidgin.im>
parents: 29465
diff changeset
736 */
f60cbf3b3ca9 Allow PRPLs to specify the image formats acceptable for thumbnails (in
Marcus Lundblad <malu@pidgin.im>
parents: 29465
diff changeset
737 const gchar *purple_xfer_get_thumbnail_mimetype(const PurpleXfer *xfer);
31293
169eeb43b52c Remove trailing whitespace
Richard Laager <rlaager@pidgin.im>
parents: 30708
diff changeset
738
169eeb43b52c Remove trailing whitespace
Richard Laager <rlaager@pidgin.im>
parents: 30708
diff changeset
739
28263
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
740 /**
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
741 * Sets the thumbnail data for a transfer
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
742 *
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
743 * @param xfer The file transfer to set the data for
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
744 * @param thumbnail A pointer to the thumbnail data, this will be copied
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
745 * @param size The size in bytes of the passed in thumbnail data
30113
f60cbf3b3ca9 Allow PRPLs to specify the image formats acceptable for thumbnails (in
Marcus Lundblad <malu@pidgin.im>
parents: 29465
diff changeset
746 * @param mimetype The mimetype of the generated thumbnail
28263
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
747 */
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
748 void purple_xfer_set_thumbnail(PurpleXfer *xfer, gconstpointer thumbnail,
30113
f60cbf3b3ca9 Allow PRPLs to specify the image formats acceptable for thumbnails (in
Marcus Lundblad <malu@pidgin.im>
parents: 29465
diff changeset
749 gsize size, const gchar *mimetype);
28263
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
750
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
751 /**
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
752 * Prepare a thumbnail for a transfer (if the UI supports it)
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
753 * will be no-op in case the UI doesn't implement thumbnail creation
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
754 *
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
755 * @param xfer The file transfer to create a thumbnail for
30114
8472e53fbbfc Set desired image formats for thumbnails as a parameter to
Marcus Lundblad <malu@pidgin.im>
parents: 30113
diff changeset
756 * @param formats A comma-separated list of mimetypes for image formats
8472e53fbbfc Set desired image formats for thumbnails as a parameter to
Marcus Lundblad <malu@pidgin.im>
parents: 30113
diff changeset
757 * the protocols can use for thumbnails.
28263
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
758 */
30114
8472e53fbbfc Set desired image formats for thumbnails as a parameter to
Marcus Lundblad <malu@pidgin.im>
parents: 30113
diff changeset
759 void purple_xfer_prepare_thumbnail(PurpleXfer *xfer, const gchar *formats);
28263
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
760
32239
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
761 /**
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
762 * Sets the protocol data for a file transfer.
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
763 *
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
764 * @param xfer The file transfer.
32554
0d844fac6679 Fix a bunch of tiny problems generating our doxygen documentation
Mark Doliner <markdoliner@pidgin.im>
parents: 32289
diff changeset
765 * @param proto_data The protocol data to set for the file transfer.
32239
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
766 */
32248
aa63f22a6e6a Rename field for consistency.
Andrew Victor <andrew.victor@mxit.com>
parents: 32239
diff changeset
767 void purple_xfer_set_protocol_data(PurpleXfer *xfer, gpointer proto_data);
32239
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
768
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
769 /**
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
770 * Gets the protocol data for a file transfer.
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
771 *
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
772 * @param xfer The file transfer.
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
773 *
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
774 * @return The protocol data for the file transfer.
3d93edd94500 Introduce API purple_xfer_get_protocol_data() and purple_xfer_set_protocol_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 31293
diff changeset
775 */
32256
620e4580252a These pointers should rather be marked const.
Andrew Victor <andrew.victor@mxit.com>
parents: 32249
diff changeset
776 gpointer purple_xfer_get_protocol_data(const PurpleXfer *xfer);
28263
d525655fd0f1 It broke a bit during merge.
Marcus Lundblad <malu@pidgin.im>
parents: 28262
diff changeset
777
32249
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
778 /**
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
779 * Set the UI data associated with this file transfer.
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
780 *
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
781 * @param xfer The file transfer.
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
782 * @param ui_data A pointer to associate with this file transfer.
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
783 */
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
784 void purple_xfer_set_ui_data(PurpleXfer *xfer, gpointer ui_data);
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
785
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
786 /**
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
787 * Get the UI data associated with this file transfer.
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
788 *
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
789 * @param xfer The file transfer.
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
790 *
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
791 * @return The UI data associated with this file transfer. This is a
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
792 * convenience field provided to the UIs--it is not
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
793 * used by the libpurple core.
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
794 */
32256
620e4580252a These pointers should rather be marked const.
Andrew Victor <andrew.victor@mxit.com>
parents: 32249
diff changeset
795 gpointer purple_xfer_get_ui_data(const PurpleXfer *xfer);
32249
b636d2273c64 Added accessor functions purple_xfer_get_ui_data() and purple_xfer_set_ui_data().
Andrew Victor <andrew.victor@mxit.com>
parents: 32248
diff changeset
796
6263
6fec763a314c [gaim-migrate @ 6760]
Christian Hammond <chipx86@chipx86.com>
parents: 6241
diff changeset
797 /*@}*/
6fec763a314c [gaim-migrate @ 6760]
Christian Hammond <chipx86@chipx86.com>
parents: 6241
diff changeset
798
6fec763a314c [gaim-migrate @ 6760]
Christian Hammond <chipx86@chipx86.com>
parents: 6241
diff changeset
799 /**************************************************************************/
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
800 /** @name File Transfer Subsystem API */
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
801 /**************************************************************************/
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
802 /*@{*/
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
803
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
804 /**
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
805 * Returns all xfers
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
806 *
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
807 * @return all current xfers with refs
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
808 */
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
809 GList *purple_xfers_get_all(void);
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
810
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
811 /**
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
812 * Returns the handle to the file transfer subsystem
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
813 *
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
814 * @return The handle
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
815 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
816 void *purple_xfers_get_handle(void);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
817
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
818 /**
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
819 * Initializes the file transfer subsystem
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
820 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
821 void purple_xfers_init(void);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
822
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
823 /**
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
824 * Uninitializes the file transfer subsystem
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
825 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
826 void purple_xfers_uninit(void);
11281
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
827
a5cda37a16be [gaim-migrate @ 13478]
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents: 11159
diff changeset
828 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
829 * Sets the UI operations structure to be used in all purple file transfers.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
830 *
6720
cdc5348dd848 [gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents: 6269
diff changeset
831 * @param ops The UI operations structure.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
832 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
833 void purple_xfers_set_ui_ops(PurpleXferUiOps *ops);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
834
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
835 /**
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
836 * Returns the UI operations structure to be used in all purple file transfers.
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
837 *
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
838 * @return The UI operations structure.
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
839 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15702
diff changeset
840 PurpleXferUiOps *purple_xfers_get_ui_ops(void);
4514
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
841
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
842 /*@}*/
40e3588a280f [gaim-migrate @ 4792]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
843
32787
7072f190d6ad Use G_BEGIN/END_DECLS in public libpurple files. This was
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32663
diff changeset
844 G_END_DECLS
5944
f19df037ac58 [gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents: 5872
diff changeset
845
34909
91be147083c6 Started GObjectification of PurpleXfer.
Ankit Vani <a@nevitus.org>
parents: 34878
diff changeset
846 #endif /* _PURPLE_XFER_H_ */
32663
1b87b3e98b0a Upgrade PurpleXfer for a 64-bit world.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 32608
diff changeset
847

mercurial