Mercurial > pidgin.yaz
annotate libpurple/connection.h @ 32619:17c27a527004
Add some boilerplate Conversation theme GObjects. These don't do
anything yet, and aren't used either.
author | Elliott Sales de Andrade <qulogic@pidgin.im> |
---|---|
date | Sat, 17 Sep 2011 05:27:30 +0000 |
parents | a5b556ac1de5 |
children | 2571b01e849c |
rev | line source |
---|---|
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
2 * @file connection.h Connection API |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
3 * @ingroup core |
20799
f296be2a1039
All the links to libpurple signal pages were in the comment containing the
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
4 * @see @ref connection-signals |
20074
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19696
diff
changeset
|
5 */ |
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19696
diff
changeset
|
6 |
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19696
diff
changeset
|
7 /* purple |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
8 * |
15823 | 9 * Purple is the legal property of its developers, whose names are too numerous |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
10 * to list here. Please refer to the COPYRIGHT file distributed with this |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
11 * source distribution. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
12 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
13 * This program is free software; you can redistribute it and/or modify |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
14 * it under the terms of the GNU General Public License as published by |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
15 * the Free Software Foundation; either version 2 of the License, or |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
16 * (at your option) any later version. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
17 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
18 * This program is distributed in the hope that it will be useful, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
21 * GNU General Public License for more details. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
22 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
23 * You should have received a copy of the GNU General Public License |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
24 * along with this program; if not, write to the Free Software |
19680
44b4e8bd759b
The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
18835
diff
changeset
|
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
26 */ |
15823 | 27 #ifndef _PURPLE_CONNECTION_H_ |
28 #define _PURPLE_CONNECTION_H_ | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
29 |
23374
0efa36fe7d7c
Sprinkle @copydoc around to squash "ref could not be resolved" Doxygen warnings,
Will Thompson <will.thompson@collabora.co.uk>
parents:
23133
diff
changeset
|
30 /** @copydoc _PurpleConnection */ |
15823 | 31 typedef struct _PurpleConnection PurpleConnection; |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
32 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
33 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
34 * Flags to change behavior of the client for a given connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
35 */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
36 typedef enum |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
37 { |
15823 | 38 PURPLE_CONNECTION_HTML = 0x0001, /**< Connection sends/receives in 'HTML'. */ |
39 PURPLE_CONNECTION_NO_BGCOLOR = 0x0002, /**< Connection does not send/receive | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
40 background colors. */ |
15823 | 41 PURPLE_CONNECTION_AUTO_RESP = 0x0004, /**< Send auto responses when away. */ |
42 PURPLE_CONNECTION_FORMATTING_WBFO = 0x0008, /**< The text buffer must be formatted as a whole */ | |
43 PURPLE_CONNECTION_NO_NEWLINES = 0x0010, /**< No new lines are allowed in outgoing messages */ | |
44 PURPLE_CONNECTION_NO_FONTSIZE = 0x0020, /**< Connection does not send/receive font sizes */ | |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
45 PURPLE_CONNECTION_NO_URLDESC = 0x0040, /**< Connection does not support descriptions with links */ |
15823 | 46 PURPLE_CONNECTION_NO_IMAGES = 0x0080, /**< Connection does not support sending of images */ |
29929
3e5bb4e2334c
Added PurpleConnection flags to determine support for moods and mood messages.
Marcus Lundblad <ml@update.uu.se>
parents:
29688
diff
changeset
|
47 PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY = 0x0100, /**< Connection supports sending and receiving custom smileys */ |
3e5bb4e2334c
Added PurpleConnection flags to determine support for moods and mood messages.
Marcus Lundblad <ml@update.uu.se>
parents:
29688
diff
changeset
|
48 PURPLE_CONNECTION_SUPPORT_MOODS = 0x0200, /**< Connection supports setting moods */ |
3e5bb4e2334c
Added PurpleConnection flags to determine support for moods and mood messages.
Marcus Lundblad <ml@update.uu.se>
parents:
29688
diff
changeset
|
49 PURPLE_CONNECTION_SUPPORT_MOOD_MESSAGES = 0x0400 /**< Connection supports setting a message on moods */ |
15823 | 50 } PurpleConnectionFlags; |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
51 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
52 typedef enum |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
53 { |
15823 | 54 PURPLE_DISCONNECTED = 0, /**< Disconnected. */ |
55 PURPLE_CONNECTED, /**< Connected. */ | |
56 PURPLE_CONNECTING /**< Connecting. */ | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
57 |
15823 | 58 } PurpleConnectionState; |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
59 |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
60 /** |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
61 * Possible errors that can cause a connection to be closed. |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
62 * |
20893
c521b0f72a7b
Add "@since 2.3.0" annotations to the new API, as advocated by rlaager.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20821
diff
changeset
|
63 * @since 2.3.0 |
c521b0f72a7b
Add "@since 2.3.0" annotations to the new API, as advocated by rlaager.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20821
diff
changeset
|
64 */ |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
65 typedef enum |
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
66 { |
20114
a465779350aa
Clarified the meaning of PURPLE_REASON_NETWORK_ERROR and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20110
diff
changeset
|
67 /** There was an error sending or receiving on the network socket, or |
a465779350aa
Clarified the meaning of PURPLE_REASON_NETWORK_ERROR and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20110
diff
changeset
|
68 * there was some protocol error (such as the server sending malformed |
a465779350aa
Clarified the meaning of PURPLE_REASON_NETWORK_ERROR and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20110
diff
changeset
|
69 * data). |
a465779350aa
Clarified the meaning of PURPLE_REASON_NETWORK_ERROR and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20110
diff
changeset
|
70 */ |
21358 | 71 PURPLE_CONNECTION_ERROR_NETWORK_ERROR = 0, |
21422
56a608b80fda
Add PURPLE_CONNECTION_ERROR_{INVALID_USERNAME,INCORRECT_PASSWORD}, to be used
Will Thompson <will.thompson@collabora.co.uk>
parents:
21392
diff
changeset
|
72 /** The username supplied was not valid. */ |
56a608b80fda
Add PURPLE_CONNECTION_ERROR_{INVALID_USERNAME,INCORRECT_PASSWORD}, to be used
Will Thompson <will.thompson@collabora.co.uk>
parents:
21392
diff
changeset
|
73 PURPLE_CONNECTION_ERROR_INVALID_USERNAME = 1, |
56a608b80fda
Add PURPLE_CONNECTION_ERROR_{INVALID_USERNAME,INCORRECT_PASSWORD}, to be used
Will Thompson <will.thompson@collabora.co.uk>
parents:
21392
diff
changeset
|
74 /** The username, password or some other credential was incorrect. Use |
21426
8ffb65f3c0e9
Clarify PURPLE_CONNECTION_ERROR_INVALID_USERNAME slightly.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21424
diff
changeset
|
75 * #PURPLE_CONNECTION_ERROR_INVALID_USERNAME instead if the username |
25449
375f82b53e95
Fix a minor whitespace inconsistency.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
25416
diff
changeset
|
76 * is known to be invalid. |
20114
a465779350aa
Clarified the meaning of PURPLE_REASON_NETWORK_ERROR and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20110
diff
changeset
|
77 */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
78 PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED = 2, |
20114
a465779350aa
Clarified the meaning of PURPLE_REASON_NETWORK_ERROR and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20110
diff
changeset
|
79 /** libpurple doesn't speak any of the authentication methods the |
a465779350aa
Clarified the meaning of PURPLE_REASON_NETWORK_ERROR and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20110
diff
changeset
|
80 * server offered. |
a465779350aa
Clarified the meaning of PURPLE_REASON_NETWORK_ERROR and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20110
diff
changeset
|
81 */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
82 PURPLE_CONNECTION_ERROR_AUTHENTICATION_IMPOSSIBLE = 3, |
20792
682543aced31
Split the "you don't have SSL support" meaning of
Will Thompson <will.thompson@collabora.co.uk>
parents:
20128
diff
changeset
|
83 /** libpurple was built without SSL support, and the connection needs |
682543aced31
Split the "you don't have SSL support" meaning of
Will Thompson <will.thompson@collabora.co.uk>
parents:
20128
diff
changeset
|
84 * SSL. |
682543aced31
Split the "you don't have SSL support" meaning of
Will Thompson <will.thompson@collabora.co.uk>
parents:
20128
diff
changeset
|
85 */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
86 PURPLE_CONNECTION_ERROR_NO_SSL_SUPPORT = 4, |
20792
682543aced31
Split the "you don't have SSL support" meaning of
Will Thompson <will.thompson@collabora.co.uk>
parents:
20128
diff
changeset
|
87 /** There was an error negotiating SSL on this connection, or the |
682543aced31
Split the "you don't have SSL support" meaning of
Will Thompson <will.thompson@collabora.co.uk>
parents:
20128
diff
changeset
|
88 * server does not support encryption but an account option was set to |
682543aced31
Split the "you don't have SSL support" meaning of
Will Thompson <will.thompson@collabora.co.uk>
parents:
20128
diff
changeset
|
89 * require it. |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
90 */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
91 PURPLE_CONNECTION_ERROR_ENCRYPTION_ERROR = 5, |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
92 /** Someone is already connected to the server using the name you are |
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
93 * trying to connect with. |
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
94 */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
95 PURPLE_CONNECTION_ERROR_NAME_IN_USE = 6, |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
96 |
20128
57e9d1ecefff
Rename PURPLE_REASON_INVALID_USERNAME to PURPLE_REASON_INVALID_SETTINGS, so it
Will Thompson <will.thompson@collabora.co.uk>
parents:
20115
diff
changeset
|
97 /** The username/server/other preference for the account isn't valid. |
25416
6e1967b0f90b
Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <mark@kingant.net>
parents:
25412
diff
changeset
|
98 * For instance, on IRC the username cannot contain white space. |
20128
57e9d1ecefff
Rename PURPLE_REASON_INVALID_USERNAME to PURPLE_REASON_INVALID_SETTINGS, so it
Will Thompson <will.thompson@collabora.co.uk>
parents:
20115
diff
changeset
|
99 * This reason should not be used for incorrect passwords etc: use |
21358 | 100 * #PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED for that. |
20128
57e9d1ecefff
Rename PURPLE_REASON_INVALID_USERNAME to PURPLE_REASON_INVALID_SETTINGS, so it
Will Thompson <will.thompson@collabora.co.uk>
parents:
20115
diff
changeset
|
101 * |
20110
ed4c1053c3da
Add PURPLE_REASON_INVALID_USERNAME, which should go away as soon as there's
Will Thompson <will.thompson@collabora.co.uk>
parents:
20107
diff
changeset
|
102 * @todo This reason really shouldn't be necessary. Usernames and |
ed4c1053c3da
Add PURPLE_REASON_INVALID_USERNAME, which should go away as soon as there's
Will Thompson <will.thompson@collabora.co.uk>
parents:
20107
diff
changeset
|
103 * other account preferences should be validated when the |
ed4c1053c3da
Add PURPLE_REASON_INVALID_USERNAME, which should go away as soon as there's
Will Thompson <will.thompson@collabora.co.uk>
parents:
20107
diff
changeset
|
104 * account is created. |
ed4c1053c3da
Add PURPLE_REASON_INVALID_USERNAME, which should go away as soon as there's
Will Thompson <will.thompson@collabora.co.uk>
parents:
20107
diff
changeset
|
105 */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
106 PURPLE_CONNECTION_ERROR_INVALID_SETTINGS = 7, |
20110
ed4c1053c3da
Add PURPLE_REASON_INVALID_USERNAME, which should go away as soon as there's
Will Thompson <will.thompson@collabora.co.uk>
parents:
20107
diff
changeset
|
107 |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
108 /** The server did not provide a SSL certificate. */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
109 PURPLE_CONNECTION_ERROR_CERT_NOT_PROVIDED = 8, |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
110 /** The server's SSL certificate could not be trusted. */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
111 PURPLE_CONNECTION_ERROR_CERT_UNTRUSTED = 9, |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
112 /** The server's SSL certificate has expired. */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
113 PURPLE_CONNECTION_ERROR_CERT_EXPIRED = 10, |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
114 /** The server's SSL certificate is not yet valid. */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
115 PURPLE_CONNECTION_ERROR_CERT_NOT_ACTIVATED = 11, |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
116 /** The server's SSL certificate did not match its hostname. */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
117 PURPLE_CONNECTION_ERROR_CERT_HOSTNAME_MISMATCH = 12, |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
118 /** The server's SSL certificate does not have the expected |
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
119 * fingerprint. |
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
120 */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
121 PURPLE_CONNECTION_ERROR_CERT_FINGERPRINT_MISMATCH = 13, |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
122 /** The server's SSL certificate is self-signed. */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
123 PURPLE_CONNECTION_ERROR_CERT_SELF_SIGNED = 14, |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
124 /** There was some other error validating the server's SSL certificate. |
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
125 */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
126 PURPLE_CONNECTION_ERROR_CERT_OTHER_ERROR = 15, |
20065
a1c47a5f07f4
Remove non-error PurpleDisconnectReasons, and add PURPLE_REASON_OTHER_ERROR
Will Thompson <will.thompson@collabora.co.uk>
parents:
20064
diff
changeset
|
127 |
23376
85fc34efe733
Fix occurred to be spelled correctly. Thanks to bruce89 for noticing. Fixes #6096.
Daniel Atallah <daniel.atallah@gmail.com>
parents:
23374
diff
changeset
|
128 /** Some other error occurred which fits into none of the other |
20065
a1c47a5f07f4
Remove non-error PurpleDisconnectReasons, and add PURPLE_REASON_OTHER_ERROR
Will Thompson <will.thompson@collabora.co.uk>
parents:
20064
diff
changeset
|
129 * categories. |
a1c47a5f07f4
Remove non-error PurpleDisconnectReasons, and add PURPLE_REASON_OTHER_ERROR
Will Thompson <will.thompson@collabora.co.uk>
parents:
20064
diff
changeset
|
130 */ |
32330
a5b556ac1de5
Rename purple_connection_error_reason to purple_connection_error
Mark Doliner <mark@kingant.net>
parents:
32329
diff
changeset
|
131 /* purple_connection_error() in connection.c uses the fact that |
21357
5a3242b676ad
rlaager suggested using the last element of the PurpleDisconnectReason enum
Will Thompson <will.thompson@collabora.co.uk>
parents:
20893
diff
changeset
|
132 * this is the last member of the enum when sanity-checking; if other |
5a3242b676ad
rlaager suggested using the last element of the PurpleDisconnectReason enum
Will Thompson <will.thompson@collabora.co.uk>
parents:
20893
diff
changeset
|
133 * reasons are added after it, the check must be updated. |
5a3242b676ad
rlaager suggested using the last element of the PurpleDisconnectReason enum
Will Thompson <will.thompson@collabora.co.uk>
parents:
20893
diff
changeset
|
134 */ |
21424
ba061949650c
I don't think that incorrect passwords can be helpfully distinguished from
Will Thompson <will.thompson@collabora.co.uk>
parents:
21422
diff
changeset
|
135 PURPLE_CONNECTION_ERROR_OTHER_ERROR = 16 |
21358 | 136 } PurpleConnectionError; |
20064
4da314b1e53e
Create a PurpleDisconnectReason enum (which happens to be identical to
Will Thompson <will.thompson@collabora.co.uk>
parents:
19696
diff
changeset
|
137 |
21374
71c1f2da4ff2
PurpleConnectionErrorPair is a better name for struct { PurpleConnectionError;
Will Thompson <will.thompson@collabora.co.uk>
parents:
21360
diff
changeset
|
138 /** Holds the type of an error along with its description. */ |
71c1f2da4ff2
PurpleConnectionErrorPair is a better name for struct { PurpleConnectionError;
Will Thompson <will.thompson@collabora.co.uk>
parents:
21360
diff
changeset
|
139 typedef struct |
71c1f2da4ff2
PurpleConnectionErrorPair is a better name for struct { PurpleConnectionError;
Will Thompson <will.thompson@collabora.co.uk>
parents:
21360
diff
changeset
|
140 { |
71c1f2da4ff2
PurpleConnectionErrorPair is a better name for struct { PurpleConnectionError;
Will Thompson <will.thompson@collabora.co.uk>
parents:
21360
diff
changeset
|
141 /** The type of error. */ |
71c1f2da4ff2
PurpleConnectionErrorPair is a better name for struct { PurpleConnectionError;
Will Thompson <will.thompson@collabora.co.uk>
parents:
21360
diff
changeset
|
142 PurpleConnectionError type; |
71c1f2da4ff2
PurpleConnectionErrorPair is a better name for struct { PurpleConnectionError;
Will Thompson <will.thompson@collabora.co.uk>
parents:
21360
diff
changeset
|
143 /** A localised, human-readable description of the error. */ |
21392
2daec6b5bbca
PurpleConnectionErrorInfo.description should not be const.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21377
diff
changeset
|
144 char *description; |
21377
872068d10eab
Mark pointed out that PurpleConnectionErrorPair is not a very good name for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
21376
diff
changeset
|
145 } PurpleConnectionErrorInfo; |
21374
71c1f2da4ff2
PurpleConnectionErrorPair is a better name for struct { PurpleConnectionError;
Will Thompson <will.thompson@collabora.co.uk>
parents:
21360
diff
changeset
|
146 |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
147 #include <time.h> |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
148 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
149 #include "account.h" |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
150 #include "plugin.h" |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
151 #include "status.h" |
20115
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20114
diff
changeset
|
152 #include "sslconn.h" |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
153 |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
154 /** |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
155 * Connection UI operations. Used to notify the user of changes to |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
156 * connections, such as being disconnected, and to respond to the |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
157 * underlying network connection appearing and disappearing. UIs should |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
158 * call #purple_connections_set_ui_ops() with an instance of this struct. |
18835
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
159 * |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
160 * @see @ref ui-ops |
18835
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
161 */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
162 typedef struct |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
163 { |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
164 /** |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
165 * When an account is connecting, this operation is called to notify |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
166 * the UI of what is happening, as well as which @a step out of @a |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
167 * step_count has been reached (which might be displayed as a progress |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
168 * bar). |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
169 * @see #purple_connection_update_progress |
18835
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
170 */ |
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
171 void (*connect_progress)(PurpleConnection *gc, |
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
172 const char *text, |
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
173 size_t step, |
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
174 size_t step_count); |
20066
95b2b7a39585
Create PurpleConnectionUiOps.report_disconnect_reason and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20065
diff
changeset
|
175 |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
176 /** |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
177 * Called when a connection is established (just before the |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
178 * @ref signed-on signal). |
18835
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
179 */ |
15823 | 180 void (*connected)(PurpleConnection *gc); |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
181 |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
182 /** |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
183 * Called when a connection is ended (between the @ref signing-off |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
184 * and @ref signed-off signals). |
18835
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
185 */ |
15823 | 186 void (*disconnected)(PurpleConnection *gc); |
20066
95b2b7a39585
Create PurpleConnectionUiOps.report_disconnect_reason and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20065
diff
changeset
|
187 |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
188 /** |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
189 * Used to display connection-specific notices. (Pidgin's Gtk user |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
190 * interface implements this as a no-op; #purple_connection_notice(), |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
191 * which uses this operation, is not used by any of the protocols |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
192 * shipped with libpurple.) |
18835
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
193 */ |
15823 | 194 void (*notice)(PurpleConnection *gc, const char *text); |
20066
95b2b7a39585
Create PurpleConnectionUiOps.report_disconnect_reason and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20065
diff
changeset
|
195 |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
196 /** |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
197 * Called when libpurple discovers that the computer's network |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
198 * connection is active. On Linux, this uses Network Manager if |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
199 * available; on Windows, it uses Win32's network change notification |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
200 * infrastructure. |
18835
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
201 */ |
21968
a463f05b4566
Felipe Contreras, one of our older Crazy Pacth Writers, noticed that these
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
21426
diff
changeset
|
202 void (*network_connected)(void); |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
203 |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
204 /** |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
205 * Called when libpurple discovers that the computer's network |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
206 * connection has gone away. |
18835
3750e2e176cb
Document PurpleConnectionUiOps. (Does purple_connection_notice predate the
Will Thompson <will.thompson@collabora.co.uk>
parents:
18118
diff
changeset
|
207 */ |
21968
a463f05b4566
Felipe Contreras, one of our older Crazy Pacth Writers, noticed that these
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
21426
diff
changeset
|
208 void (*network_disconnected)(void); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
209 |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
210 /** |
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
211 * Called when an error causes a connection to be disconnected. |
32325
af709c6ab032
Remove PurpleConnectionUiOps.report_disconnect
Mark Doliner <mark@kingant.net>
parents:
29929
diff
changeset
|
212 * Called before #disconnected. |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
213 * |
32325
af709c6ab032
Remove PurpleConnectionUiOps.report_disconnect
Mark Doliner <mark@kingant.net>
parents:
29929
diff
changeset
|
214 * @param reason why the connection ended, if known, or |
af709c6ab032
Remove PurpleConnectionUiOps.report_disconnect
Mark Doliner <mark@kingant.net>
parents:
29929
diff
changeset
|
215 * #PURPLE_CONNECTION_ERROR_OTHER_ERROR, if not. |
af709c6ab032
Remove PurpleConnectionUiOps.report_disconnect
Mark Doliner <mark@kingant.net>
parents:
29929
diff
changeset
|
216 * @param text a localized message describing the disconnection |
af709c6ab032
Remove PurpleConnectionUiOps.report_disconnect
Mark Doliner <mark@kingant.net>
parents:
29929
diff
changeset
|
217 * in more detail to the user. |
32330
a5b556ac1de5
Rename purple_connection_error_reason to purple_connection_error
Mark Doliner <mark@kingant.net>
parents:
32329
diff
changeset
|
218 * @see #purple_connection_error |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
219 * |
32325
af709c6ab032
Remove PurpleConnectionUiOps.report_disconnect
Mark Doliner <mark@kingant.net>
parents:
29929
diff
changeset
|
220 * @since 2.3.0 |
20066
95b2b7a39585
Create PurpleConnectionUiOps.report_disconnect_reason and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20065
diff
changeset
|
221 */ |
32326
c3ea1711c372
Rename the report_disconnect_reason cb function to report_disconnect
Mark Doliner <mark@kingant.net>
parents:
32325
diff
changeset
|
222 void (*report_disconnect)(PurpleConnection *gc, |
c3ea1711c372
Rename the report_disconnect_reason cb function to report_disconnect
Mark Doliner <mark@kingant.net>
parents:
32325
diff
changeset
|
223 PurpleConnectionError reason, |
c3ea1711c372
Rename the report_disconnect_reason cb function to report_disconnect
Mark Doliner <mark@kingant.net>
parents:
32325
diff
changeset
|
224 const char *text); |
20066
95b2b7a39585
Create PurpleConnectionUiOps.report_disconnect_reason and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20065
diff
changeset
|
225 |
16672
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15823
diff
changeset
|
226 void (*_purple_reserved1)(void); |
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15823
diff
changeset
|
227 void (*_purple_reserved2)(void); |
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15823
diff
changeset
|
228 void (*_purple_reserved3)(void); |
15823 | 229 } PurpleConnectionUiOps; |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
230 |
23374
0efa36fe7d7c
Sprinkle @copydoc around to squash "ref could not be resolved" Doxygen warnings,
Will Thompson <will.thompson@collabora.co.uk>
parents:
23133
diff
changeset
|
231 |
0efa36fe7d7c
Sprinkle @copydoc around to squash "ref could not be resolved" Doxygen warnings,
Will Thompson <will.thompson@collabora.co.uk>
parents:
23133
diff
changeset
|
232 /* Represents an active connection on an account. */ |
15823 | 233 struct _PurpleConnection |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
234 { |
15823 | 235 PurplePlugin *prpl; /**< The protocol plugin. */ |
236 PurpleConnectionFlags flags; /**< Connection flags. */ | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
237 |
15823 | 238 PurpleConnectionState state; /**< The connection state. */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
239 |
15823 | 240 PurpleAccount *account; /**< The account being connected to. */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
241 char *password; /**< The password used. */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
242 int inpa; /**< The input watcher. */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
243 |
20813
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
244 GSList *buddy_chats; /**< A list of active chats |
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
245 (#PurpleConversation structs of type |
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
246 #PURPLE_CONV_TYPE_CHAT). */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
247 void *proto_data; /**< Protocol-specific data. */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
248 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
249 char *display_name; /**< How you appear to other people. */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
250 guint keepalive; /**< Keep-alive. */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
251 |
20813
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
252 /** Wants to Die state. This is set when the user chooses to log out, or |
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
253 * when the protocol is disconnected and should not be automatically |
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
254 * reconnected (incorrect password, etc.). prpls should rely on |
32330
a5b556ac1de5
Rename purple_connection_error_reason to purple_connection_error
Mark Doliner <mark@kingant.net>
parents:
32329
diff
changeset
|
255 * purple_connection_error() to set this for them rather than |
20813
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
256 * setting it themselves. |
21358 | 257 * @see purple_connection_error_is_fatal |
20813
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
258 */ |
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
259 gboolean wants_to_die; |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
260 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
261 guint disconnect_timeout; /**< Timer used for nasty stack tricks */ |
22149
252b96b6a32c
Don't send keep-alives if we've received data since in the last KEEPALIVE_INTERVAL seconds
Sean Egan <seanegan@gmail.com>
parents:
21968
diff
changeset
|
262 time_t last_received; /**< When we last received a packet. Set by the |
252b96b6a32c
Don't send keep-alives if we've received data since in the last KEEPALIVE_INTERVAL seconds
Sean Egan <seanegan@gmail.com>
parents:
21968
diff
changeset
|
263 prpl to avoid sending unneeded keepalives */ |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
264 }; |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
265 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
266 #ifdef __cplusplus |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
267 extern "C" { |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
268 #endif |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
269 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
270 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
271 /** @name Connection API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
272 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
273 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
274 |
24292
8282911d5e17
Build everything with the *_DISABLE_DEPRECATED flags set. This allows us
Richard Laager <rlaager@wiktel.com>
parents:
23376
diff
changeset
|
275 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_CONNECTION_C_) |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
276 /** |
15823 | 277 * This function should only be called by purple_account_connect() |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
278 * in account.c. If you're trying to sign on an account, use that |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
279 * function instead. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
280 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
281 * Creates a connection to the specified account and either connects |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
282 * or attempts to register a new account. If you are logging in, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
283 * the connection uses the current active status for this account. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
284 * So if you want to sign on as "away," for example, you need to |
15823 | 285 * have called purple_account_set_status(account, "away"). |
286 * (And this will call purple_account_connect() automatically). | |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
287 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
288 * @param account The account the connection should be connecting to. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
289 * @param regist Whether we are registering a new account or just |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
290 * trying to do a normal signon. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
291 * @param password The password to use. |
21241
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
292 * |
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
293 * @deprecated As this is internal, we should make it private in 3.0.0. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
294 */ |
15823 | 295 void purple_connection_new(PurpleAccount *account, gboolean regist, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
296 const char *password); |
21241
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
297 #endif |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
298 |
24292
8282911d5e17
Build everything with the *_DISABLE_DEPRECATED flags set. This allows us
Richard Laager <rlaager@wiktel.com>
parents:
23376
diff
changeset
|
299 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_CONNECTION_C_) |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
300 /** |
18703
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
301 * This function should only be called by purple_account_unregister() |
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
302 * in account.c. |
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
303 * |
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
304 * Tries to unregister the account on the server. If the account is not |
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
305 * connected, also creates a new connection. |
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
306 * |
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
307 * @param account The account to unregister |
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
308 * @param password The password to use. |
21241
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
309 * @param cb Optional callback to be called when unregistration is complete |
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
310 * @param user_data user data to pass to the callback |
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
311 * |
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
312 * @deprecated As this is internal, we should make it private in 3.0.0. |
18703
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
313 */ |
18920
2a9d60d7af82
Implemented a callback for unregistering, mirroring the registration callback. Since this is a new API, I can do it properly by passing it right in the unregister function call, instead of having a separate function for setting it.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18703
diff
changeset
|
314 void purple_connection_new_unregister(PurpleAccount *account, const char *password, PurpleAccountUnregistrationCb cb, void *user_data); |
21241
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
315 #endif |
18703
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
316 |
24292
8282911d5e17
Build everything with the *_DISABLE_DEPRECATED flags set. This allows us
Richard Laager <rlaager@wiktel.com>
parents:
23376
diff
changeset
|
317 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_CONNECTION_C_) |
18703
033b128f7c21
Added unregistering XMPP accounts. This requires a new prpl-struct entry, but I got an ok for that on the mailing list.
Andreas Monitzer <pidgin@monitzer.com>
parents:
18118
diff
changeset
|
318 /** |
15823 | 319 * Disconnects and destroys a PurpleConnection. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
320 * |
15823 | 321 * This function should only be called by purple_account_disconnect() |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
322 * in account.c. If you're trying to sign off an account, use that |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
323 * function instead. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
324 * |
15823 | 325 * @param gc The purple connection to destroy. |
21241
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
326 * |
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
327 * @deprecated As this is internal, we should make it private in 3.0.0. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
328 */ |
15823 | 329 void purple_connection_destroy(PurpleConnection *gc); |
21241
d8990c20cbee
Mark some libpurple-internal functions as deprecated to further help keep
Richard Laager <rlaager@wiktel.com>
parents:
20799
diff
changeset
|
330 #endif |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
331 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
332 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
333 * Sets the connection state. PRPLs should call this and pass in |
20813
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
334 * the state #PURPLE_CONNECTED when the account is completely |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
335 * signed on. What does it mean to be completely signed on? If |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
336 * the core can call prpl->set_status, and it successfully changes |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
337 * your status, then the account is online. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
338 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
339 * @param gc The connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
340 * @param state The connection state. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
341 */ |
15823 | 342 void purple_connection_set_state(PurpleConnection *gc, PurpleConnectionState state); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
343 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
344 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
345 * Sets the connection's account. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
346 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
347 * @param gc The connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
348 * @param account The account. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
349 */ |
15823 | 350 void purple_connection_set_account(PurpleConnection *gc, PurpleAccount *account); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
351 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
352 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
353 * Sets the connection's displayed name. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
354 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
355 * @param gc The connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
356 * @param name The displayed name. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
357 */ |
15823 | 358 void purple_connection_set_display_name(PurpleConnection *gc, const char *name); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
359 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
360 /** |
25281
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
361 * Sets the protocol data for a connection. |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
362 * |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
363 * @param connection The PurpleConnection. |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
364 * @param proto_data The protocol data to set for the connection. |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
365 * |
25285
d719b9d82540
Add @since 2.6.0 tags for purple_connection_set_protocol_data() and
Richard Laager <rlaager@wiktel.com>
parents:
25281
diff
changeset
|
366 * @since 2.6.0 |
25281
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
367 */ |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
368 void purple_connection_set_protocol_data(PurpleConnection *connection, void *proto_data); |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
369 |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
370 /** |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
371 * Returns the connection state. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
372 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
373 * @param gc The connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
374 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
375 * @return The connection state. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
376 */ |
15823 | 377 PurpleConnectionState purple_connection_get_state(const PurpleConnection *gc); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
378 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
379 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
380 * Returns TRUE if the account is connected, otherwise returns FALSE. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
381 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
382 * @return TRUE if the account is connected, otherwise returns FALSE. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
383 */ |
15823 | 384 #define PURPLE_CONNECTION_IS_CONNECTED(gc) \ |
22214
2b426862ffbf
Add accessor and update finch to not touch the internals of PurpleConnection.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22149
diff
changeset
|
385 (purple_connection_get_state(gc) == PURPLE_CONNECTED) |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
386 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
387 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
388 * Returns the connection's account. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
389 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
390 * @param gc The connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
391 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
392 * @return The connection's account. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
393 */ |
15823 | 394 PurpleAccount *purple_connection_get_account(const PurpleConnection *gc); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
395 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
396 /** |
22214
2b426862ffbf
Add accessor and update finch to not touch the internals of PurpleConnection.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22149
diff
changeset
|
397 * Returns the protocol plugin managing a connection. |
2b426862ffbf
Add accessor and update finch to not touch the internals of PurpleConnection.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22149
diff
changeset
|
398 * |
2b426862ffbf
Add accessor and update finch to not touch the internals of PurpleConnection.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22149
diff
changeset
|
399 * @param gc The connection. |
2b426862ffbf
Add accessor and update finch to not touch the internals of PurpleConnection.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22149
diff
changeset
|
400 * |
2b426862ffbf
Add accessor and update finch to not touch the internals of PurpleConnection.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22149
diff
changeset
|
401 * @return The protocol plugin. |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
402 * |
22221
ef0e82b8bc2e
Forgot the since tag here.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22214
diff
changeset
|
403 * @since 2.4.0 |
22214
2b426862ffbf
Add accessor and update finch to not touch the internals of PurpleConnection.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22149
diff
changeset
|
404 */ |
2b426862ffbf
Add accessor and update finch to not touch the internals of PurpleConnection.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22149
diff
changeset
|
405 PurplePlugin * purple_connection_get_prpl(const PurpleConnection *gc); |
2b426862ffbf
Add accessor and update finch to not touch the internals of PurpleConnection.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22149
diff
changeset
|
406 |
2b426862ffbf
Add accessor and update finch to not touch the internals of PurpleConnection.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
22149
diff
changeset
|
407 /** |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
408 * Returns the connection's password. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
409 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
410 * @param gc The connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
411 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
412 * @return The connection's password. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
413 */ |
15823 | 414 const char *purple_connection_get_password(const PurpleConnection *gc); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
415 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
416 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
417 * Returns the connection's displayed name. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
418 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
419 * @param gc The connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
420 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
421 * @return The connection's displayed name. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
422 */ |
15823 | 423 const char *purple_connection_get_display_name(const PurpleConnection *gc); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
424 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
425 /** |
25281
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
426 * Gets the protocol data from a connection. |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
427 * |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
428 * @param connection The PurpleConnection. |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
429 * |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
430 * @return The protocol data for the connection. |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
431 * |
25285
d719b9d82540
Add @since 2.6.0 tags for purple_connection_set_protocol_data() and
Richard Laager <rlaager@wiktel.com>
parents:
25281
diff
changeset
|
432 * @since 2.6.0 |
25281
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
433 */ |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
434 void *purple_connection_get_protocol_data(const PurpleConnection *connection); |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
435 |
9ded0fb57e1c
Added purple_connection_set_protocol_data and purple_connection_get_protocol_data
Gary Kramlich <grim@reaperworld.com>
parents:
23376
diff
changeset
|
436 /** |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
437 * Updates the connection progress. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
438 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
439 * @param gc The connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
440 * @param text Information on the current step. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
441 * @param step The current step. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
442 * @param count The total number of steps. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
443 */ |
15823 | 444 void purple_connection_update_progress(PurpleConnection *gc, const char *text, |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
445 size_t step, size_t count); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
446 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
447 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
448 * Displays a connection-specific notice. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
449 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
450 * @param gc The connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
451 * @param text The notice text. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
452 */ |
15823 | 453 void purple_connection_notice(PurpleConnection *gc, const char *text); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
454 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
455 /** |
21359
fe57b8062249
Document that the char * parameter of purple_connection_error{,_reason} may
Will Thompson <will.thompson@collabora.co.uk>
parents:
21358
diff
changeset
|
456 * Closes a connection with an error and a human-readable description of the |
20813
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
457 * error. It also sets @c gc->wants_to_die to the value of |
21376
f5b223d0cb89
Document the gc parameter of purple_connection_error_reason to shut doxygen up.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21374
diff
changeset
|
458 * #purple_connection_error_is_fatal(@a reason), mainly for |
f5b223d0cb89
Document the gc parameter of purple_connection_error_reason to shut doxygen up.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21374
diff
changeset
|
459 * backwards-compatibility. |
20066
95b2b7a39585
Create PurpleConnectionUiOps.report_disconnect_reason and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20065
diff
changeset
|
460 * |
21376
f5b223d0cb89
Document the gc parameter of purple_connection_error_reason to shut doxygen up.
Will Thompson <will.thompson@collabora.co.uk>
parents:
21374
diff
changeset
|
461 * @param gc the connection which is closing. |
20066
95b2b7a39585
Create PurpleConnectionUiOps.report_disconnect_reason and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20065
diff
changeset
|
462 * @param reason why the connection is closing. |
21359
fe57b8062249
Document that the char * parameter of purple_connection_error{,_reason} may
Will Thompson <will.thompson@collabora.co.uk>
parents:
21358
diff
changeset
|
463 * @param description a non-@c NULL localized description of the error. |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
464 * |
20893
c521b0f72a7b
Add "@since 2.3.0" annotations to the new API, as advocated by rlaager.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20821
diff
changeset
|
465 * @since 2.3.0 |
20066
95b2b7a39585
Create PurpleConnectionUiOps.report_disconnect_reason and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20065
diff
changeset
|
466 */ |
95b2b7a39585
Create PurpleConnectionUiOps.report_disconnect_reason and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20065
diff
changeset
|
467 void |
32330
a5b556ac1de5
Rename purple_connection_error_reason to purple_connection_error
Mark Doliner <mark@kingant.net>
parents:
32329
diff
changeset
|
468 purple_connection_error(PurpleConnection *gc, |
a5b556ac1de5
Rename purple_connection_error_reason to purple_connection_error
Mark Doliner <mark@kingant.net>
parents:
32329
diff
changeset
|
469 PurpleConnectionError reason, |
a5b556ac1de5
Rename purple_connection_error_reason to purple_connection_error
Mark Doliner <mark@kingant.net>
parents:
32329
diff
changeset
|
470 const char *description); |
20066
95b2b7a39585
Create PurpleConnectionUiOps.report_disconnect_reason and
Will Thompson <will.thompson@collabora.co.uk>
parents:
20065
diff
changeset
|
471 |
20067
143c6f34c6eb
Create purple_connection_reason_is_fatal, which is basically a replacement for
Will Thompson <will.thompson@collabora.co.uk>
parents:
20066
diff
changeset
|
472 /** |
20115
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20114
diff
changeset
|
473 * Closes a connection due to an SSL error; this is basically a shortcut to |
21358 | 474 * turning the #PurpleSslErrorType into a #PurpleConnectionError and a |
32330
a5b556ac1de5
Rename purple_connection_error_reason to purple_connection_error
Mark Doliner <mark@kingant.net>
parents:
32329
diff
changeset
|
475 * human-readable string and then calling purple_connection_error(). |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
476 * |
20893
c521b0f72a7b
Add "@since 2.3.0" annotations to the new API, as advocated by rlaager.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20821
diff
changeset
|
477 * @since 2.3.0 |
20115
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20114
diff
changeset
|
478 */ |
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20114
diff
changeset
|
479 void |
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20114
diff
changeset
|
480 purple_connection_ssl_error (PurpleConnection *gc, |
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20114
diff
changeset
|
481 PurpleSslErrorType ssl_error); |
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20114
diff
changeset
|
482 |
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20114
diff
changeset
|
483 /** |
20067
143c6f34c6eb
Create purple_connection_reason_is_fatal, which is basically a replacement for
Will Thompson <will.thompson@collabora.co.uk>
parents:
20066
diff
changeset
|
484 * Reports whether a disconnection reason is fatal (in which case the account |
143c6f34c6eb
Create purple_connection_reason_is_fatal, which is basically a replacement for
Will Thompson <will.thompson@collabora.co.uk>
parents:
20066
diff
changeset
|
485 * should probably not be automatically reconnected) or transient (so |
20813
66e7b104b4ea
rlaager pointed out that purple_connection_error_reason should be setting
Will Thompson <will.thompson@collabora.co.uk>
parents:
20812
diff
changeset
|
486 * auto-reconnection is a good idea). |
21359
fe57b8062249
Document that the char * parameter of purple_connection_error{,_reason} may
Will Thompson <will.thompson@collabora.co.uk>
parents:
21358
diff
changeset
|
487 * For instance, #PURPLE_CONNECTION_ERROR_NETWORK_ERROR is a temporary error, |
fe57b8062249
Document that the char * parameter of purple_connection_error{,_reason} may
Will Thompson <will.thompson@collabora.co.uk>
parents:
21358
diff
changeset
|
488 * which might be caused by losing the network connection, so <tt> |
fe57b8062249
Document that the char * parameter of purple_connection_error{,_reason} may
Will Thompson <will.thompson@collabora.co.uk>
parents:
21358
diff
changeset
|
489 * purple_connection_error_is_fatal (PURPLE_CONNECTION_ERROR_NETWORK_ERROR)</tt> |
fe57b8062249
Document that the char * parameter of purple_connection_error{,_reason} may
Will Thompson <will.thompson@collabora.co.uk>
parents:
21358
diff
changeset
|
490 * is @c FALSE. On the other hand, |
21358 | 491 * #PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED probably indicates a |
492 * misconfiguration of the account which needs the user to go fix it up, so | |
21359
fe57b8062249
Document that the char * parameter of purple_connection_error{,_reason} may
Will Thompson <will.thompson@collabora.co.uk>
parents:
21358
diff
changeset
|
493 * <tt> purple_connection_error_is_fatal |
fe57b8062249
Document that the char * parameter of purple_connection_error{,_reason} may
Will Thompson <will.thompson@collabora.co.uk>
parents:
21358
diff
changeset
|
494 * (PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED)</tt> is @c TRUE. |
20067
143c6f34c6eb
Create purple_connection_reason_is_fatal, which is basically a replacement for
Will Thompson <will.thompson@collabora.co.uk>
parents:
20066
diff
changeset
|
495 * |
143c6f34c6eb
Create purple_connection_reason_is_fatal, which is basically a replacement for
Will Thompson <will.thompson@collabora.co.uk>
parents:
20066
diff
changeset
|
496 * (This function is meant to replace checking PurpleConnection.wants_to_die.) |
143c6f34c6eb
Create purple_connection_reason_is_fatal, which is basically a replacement for
Will Thompson <will.thompson@collabora.co.uk>
parents:
20066
diff
changeset
|
497 * |
20818
c560286daede
Clarify the documentation of the return value of
Will Thompson <will.thompson@collabora.co.uk>
parents:
20813
diff
changeset
|
498 * @return @c TRUE if the account should not be automatically reconnected, and |
c560286daede
Clarify the documentation of the return value of
Will Thompson <will.thompson@collabora.co.uk>
parents:
20813
diff
changeset
|
499 * @c FALSE otherwise. |
25412
d25cbbea7fe5
Add @since 2.6.0 doxygen comments to some of our new functions, and
Mark Doliner <mark@kingant.net>
parents:
25362
diff
changeset
|
500 * |
20893
c521b0f72a7b
Add "@since 2.3.0" annotations to the new API, as advocated by rlaager.
Will Thompson <will.thompson@collabora.co.uk>
parents:
20821
diff
changeset
|
501 * @since 2.3.0 |
20067
143c6f34c6eb
Create purple_connection_reason_is_fatal, which is basically a replacement for
Will Thompson <will.thompson@collabora.co.uk>
parents:
20066
diff
changeset
|
502 */ |
143c6f34c6eb
Create purple_connection_reason_is_fatal, which is basically a replacement for
Will Thompson <will.thompson@collabora.co.uk>
parents:
20066
diff
changeset
|
503 gboolean |
21358 | 504 purple_connection_error_is_fatal (PurpleConnectionError reason); |
20067
143c6f34c6eb
Create purple_connection_reason_is_fatal, which is basically a replacement for
Will Thompson <will.thompson@collabora.co.uk>
parents:
20066
diff
changeset
|
505 |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
506 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
507 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
508 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
509 /** @name Connections API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
510 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
511 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
512 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
513 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
514 * Disconnects from all connections. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
515 */ |
15823 | 516 void purple_connections_disconnect_all(void); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
517 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
518 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
519 * Returns a list of all active connections. This does not |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
520 * include connections that are in the process of connecting. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
521 * |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
18063
diff
changeset
|
522 * @constreturn A list of all active connections. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
523 */ |
18063
926ccb104da0
disapproval of revision '1411afd7660760db59966c3a9f18e2adab8eb27e'
Richard Laager <rlaager@wiktel.com>
parents:
18058
diff
changeset
|
524 GList *purple_connections_get_all(void); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
525 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
526 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
527 * Returns a list of all connections in the process of connecting. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
528 * |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
18063
diff
changeset
|
529 * @constreturn A list of connecting connections. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
530 */ |
18063
926ccb104da0
disapproval of revision '1411afd7660760db59966c3a9f18e2adab8eb27e'
Richard Laager <rlaager@wiktel.com>
parents:
18058
diff
changeset
|
531 GList *purple_connections_get_connecting(void); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
532 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
533 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
534 * Checks if gc is still a valid pointer to a gc. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
535 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
536 * @return @c TRUE if gc is valid. |
27207
d8afc4ba7ce6
Clarify that PURPLE_CONNECTION_IS_VALID is deprecated, in case it wasn't
Mark Doliner <mark@kingant.net>
parents:
25449
diff
changeset
|
537 * |
d8afc4ba7ce6
Clarify that PURPLE_CONNECTION_IS_VALID is deprecated, in case it wasn't
Mark Doliner <mark@kingant.net>
parents:
25449
diff
changeset
|
538 * @deprecated Do not use this. Instead, cancel your asynchronous request |
d8afc4ba7ce6
Clarify that PURPLE_CONNECTION_IS_VALID is deprecated, in case it wasn't
Mark Doliner <mark@kingant.net>
parents:
25449
diff
changeset
|
539 * when the PurpleConnection is destroyed. |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
540 */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
541 /* |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
542 * TODO: Eventually this bad boy will be removed, because it is |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
543 * a gross fix for a crashy problem. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
544 */ |
18063
926ccb104da0
disapproval of revision '1411afd7660760db59966c3a9f18e2adab8eb27e'
Richard Laager <rlaager@wiktel.com>
parents:
18058
diff
changeset
|
545 #define PURPLE_CONNECTION_IS_VALID(gc) (g_list_find(purple_connections_get_all(), (gc)) != NULL) |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
546 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
547 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
548 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
549 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
550 /** @name UI Registration Functions */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
551 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
552 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
553 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
554 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
555 * Sets the UI operations structure to be used for connections. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
556 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
557 * @param ops The UI operations structure. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
558 */ |
15823 | 559 void purple_connections_set_ui_ops(PurpleConnectionUiOps *ops); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
560 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
561 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
562 * Returns the UI operations structure used for connections. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
563 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
564 * @return The UI operations structure in use. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
565 */ |
15823 | 566 PurpleConnectionUiOps *purple_connections_get_ui_ops(void); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
567 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
568 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
569 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
570 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
571 /** @name Connections Subsystem */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
572 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
573 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
574 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
575 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
576 * Initializes the connections subsystem. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
577 */ |
15823 | 578 void purple_connections_init(void); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
579 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
580 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
581 * Uninitializes the connections subsystem. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
582 */ |
15823 | 583 void purple_connections_uninit(void); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
584 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
585 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
586 * Returns the handle to the connections subsystem. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
587 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
588 * @return The connections subsystem handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
589 */ |
15823 | 590 void *purple_connections_get_handle(void); |
15374
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
591 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
592 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
593 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
594 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
595 #ifdef __cplusplus |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
596 } |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
597 #endif |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
598 |
15823 | 599 #endif /* _PURPLE_CONNECTION_H_ */ |