Mercurial > pidgin
annotate src/connection.h @ 8863:75849c0650e5
[gaim-migrate @ 9631]
paco-paco distracted me and i got confused where i was at. i actually just
committed the code for this, now the rest
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Mon, 03 May 2004 17:55:46 +0000 |
parents | 92cbf9713795 |
children | db1dc2d02020 |
rev | line source |
---|---|
5563 | 1 /** |
2 * @file connection.h Connection API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
8046 | 7 * Gaim is the legal property of its developers, whose names are too numerous |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
6460
ff4551719cc7
[gaim-migrate @ 6969]
Christian Hammond <chipx86@chipx86.com>
parents:
6393
diff
changeset
|
10 * |
5563 | 11 * This program is free software; you can redistribute it and/or modify |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
6724
aca39e77db85
[gaim-migrate @ 7251]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
24 * |
aca39e77db85
[gaim-migrate @ 7251]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
25 * @see @ref connection-signals |
5563 | 26 */ |
27 #ifndef _GAIM_CONNECTION_H_ | |
28 #define _GAIM_CONNECTION_H_ | |
29 | |
30 #include <stdlib.h> | |
5733
4350b62bac45
[gaim-migrate @ 6157]
Christian Hammond <chipx86@chipx86.com>
parents:
5717
diff
changeset
|
31 #include <time.h> |
5563 | 32 |
33 typedef struct _GaimConnection GaimConnection; | |
34 | |
6622 | 35 /** |
36 * Flags to change behavior of the client for a given connection. | |
37 */ | |
38 typedef enum | |
39 { | |
6982 | 40 GAIM_CONNECTION_HTML = 0x0001, /**< Connection sends/receives in 'HTML'. */ |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8691
diff
changeset
|
41 GAIM_CONNECTION_NO_BGCOLOR = 0x0002, /**< Connection does not send/receive |
6982 | 42 background colors. */ |
8677 | 43 GAIM_CONNECTION_AUTO_RESP = 0x0004, /**< Send auto responses when away. */ |
44 GAIM_CONNECTION_FORMATTING_WBFO = 0x0008, /**< The text buffer must be formatted as a whole */ | |
8691
0eb5161ef333
[gaim-migrate @ 9444]
Christian Hammond <chipx86@chipx86.com>
parents:
8677
diff
changeset
|
45 GAIM_CONNECTION_NO_NEWLINES = 0x0010, /**< No new lines are allowed in outgoing messages */ |
0eb5161ef333
[gaim-migrate @ 9444]
Christian Hammond <chipx86@chipx86.com>
parents:
8677
diff
changeset
|
46 GAIM_CONNECTION_NO_FONTSIZE = 0x0020 /**< Connection does not send/receive font sizes */ |
6622 | 47 } GaimConnectionFlags; |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5733
diff
changeset
|
48 |
5563 | 49 typedef enum |
50 { | |
51 GAIM_DISCONNECTED = 0, /**< Disconnected. */ | |
52 GAIM_CONNECTED, /**< Connected. */ | |
53 GAIM_CONNECTING /**< Connecting. */ | |
54 | |
55 } GaimConnectionState; | |
56 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
57 #include "account.h" |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
58 #include "plugin.h" |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
59 |
5563 | 60 typedef struct |
61 { | |
62 void (*connect_progress)(GaimConnection *gc, const char *text, | |
63 size_t step, size_t step_count); | |
64 void (*connected)(GaimConnection *gc); | |
6460
ff4551719cc7
[gaim-migrate @ 6969]
Christian Hammond <chipx86@chipx86.com>
parents:
6393
diff
changeset
|
65 void (*disconnected)(GaimConnection *gc); |
5571
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
66 void (*notice)(GaimConnection *gc, const char *text); |
6460
ff4551719cc7
[gaim-migrate @ 6969]
Christian Hammond <chipx86@chipx86.com>
parents:
6393
diff
changeset
|
67 void (*report_disconnect)(GaimConnection *gc, const char *text); |
5563 | 68 |
69 } GaimConnectionUiOps; | |
70 | |
71 struct _GaimConnection | |
72 { | |
73 GaimPlugin *prpl; /**< The protocol plugin. */ | |
6622 | 74 GaimConnectionFlags flags; /**< Connection flags. */ |
5563 | 75 |
76 GaimConnectionState state; /**< The connection state. */ | |
77 | |
78 GaimAccount *account; /**< The account being connected to. */ | |
79 int inpa; /**< The input watcher. */ | |
80 | |
81 GSList *buddy_chats; /**< A list of active chats. */ | |
82 void *proto_data; /**< Protocol-specific data. */ | |
83 | |
84 char *display_name; /**< The name displayed. */ | |
85 guint keep_alive; /**< Keep-alive. */ | |
86 | |
87 guint idle_timer; /**< The idle timer. */ | |
88 time_t login_time; /**< Time of login. */ | |
89 time_t login_time_official; /**< Official time of login. */ | |
90 time_t last_sent_time; /**< The time something was last sent. */ | |
91 int is_idle; /**< Idle state of the connection. */ | |
92 | |
93 char *away; /**< The current away message, or NULL */ | |
94 char *away_state; /**< The last away type. */ | |
95 gboolean is_auto_away; /**< Whether or not it's auto-away. */ | |
96 | |
97 int evil; /**< Warning level for AIM (why is | |
98 this here?) */ | |
99 | |
8430 | 100 gboolean wants_to_die; /**< Wants to Die state. This is set |
101 when the user chooses to sign off, | |
102 or when the protocol is | |
103 disconnected and should not be | |
104 automatically reconnected | |
105 (incorrect password, etc.) */ | |
6393 | 106 guint disconnect_timeout; /**< Timer used for nasty stack tricks */ |
5563 | 107 }; |
108 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
109 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
110 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
111 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
112 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
113 /**************************************************************************/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
114 /** @name Connection API */ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
115 /**************************************************************************/ |
6488
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
116 /*@{*/ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
117 |
5563 | 118 /** |
119 * Creates a connection to the specified account. | |
120 * | |
121 * @param account The account the connection should be connecting to. | |
122 * | |
123 * @return The gaim connection. | |
124 */ | |
125 GaimConnection *gaim_connection_new(GaimAccount *account); | |
126 | |
127 /** | |
128 * Destroys and closes a gaim connection. | |
129 * | |
130 * @param gc The gaim connection to destroy. | |
131 */ | |
132 void gaim_connection_destroy(GaimConnection *gc); | |
133 | |
134 /** | |
135 * Signs a connection on. | |
136 * | |
137 * @param gc The connection to sign on. | |
138 * | |
139 * @see gaim_connection_disconnect() | |
140 */ | |
141 void gaim_connection_connect(GaimConnection *gc); | |
142 | |
143 /** | |
6581 | 144 * Registers a connection. |
145 * | |
146 * @param gc The connection to register. | |
147 */ | |
148 void gaim_connection_register(GaimConnection *gc); | |
149 | |
150 /** | |
5563 | 151 * Signs a connection off. |
6583
e07c66073b6d
[gaim-migrate @ 7105]
Christian Hammond <chipx86@chipx86.com>
parents:
6581
diff
changeset
|
152 * |
5563 | 153 * @param gc The connection to sign off. |
154 * | |
155 * @see gaim_connection_connect() | |
156 */ | |
157 void gaim_connection_disconnect(GaimConnection *gc); | |
158 | |
159 /** | |
160 * Sets the connection state. | |
161 * | |
162 * @param gc The connection. | |
163 * @param state The connection state. | |
164 */ | |
165 void gaim_connection_set_state(GaimConnection *gc, GaimConnectionState state); | |
166 | |
167 /** | |
168 * Sets the connection's account. | |
169 * | |
170 * @param gc The connection. | |
171 * @param account The account. | |
172 */ | |
173 void gaim_connection_set_account(GaimConnection *gc, GaimAccount *account); | |
174 | |
175 /** | |
176 * Sets the connection's displayed name. | |
177 * | |
178 * @param gc The connection. | |
179 * @param name The displayed name. | |
180 */ | |
181 void gaim_connection_set_display_name(GaimConnection *gc, const char *name); | |
182 | |
183 /** | |
184 * Returns the connection state. | |
185 * | |
186 * @param gc The connection. | |
187 * | |
188 * @return The connection state. | |
189 */ | |
190 GaimConnectionState gaim_connection_get_state(const GaimConnection *gc); | |
191 | |
192 /** | |
193 * Returns the connection's account. | |
194 * | |
195 * @param gc The connection. | |
196 * | |
197 * @return The connection's account. | |
198 */ | |
199 GaimAccount *gaim_connection_get_account(const GaimConnection *gc); | |
200 | |
201 /** | |
202 * Returns the connection's displayed name. | |
203 * | |
204 * @param gc The connection. | |
205 * | |
206 * @return The connection's displayed name. | |
207 */ | |
208 const char *gaim_connection_get_display_name(const GaimConnection *gc); | |
209 | |
210 /** | |
211 * Updates the connection progress. | |
212 * | |
213 * @param gc The connection. | |
214 * @param text Information on the current step. | |
215 * @param step The current step. | |
216 * @param count The total number of steps. | |
217 */ | |
218 void gaim_connection_update_progress(GaimConnection *gc, const char *text, | |
219 size_t step, size_t count); | |
220 | |
221 /** | |
5571
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
222 * Displays a connection-specific notice. |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
223 * |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
224 * @param gc The connection. |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
225 * @param text The notice text. |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
226 */ |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
227 void gaim_connection_notice(GaimConnection *gc, const char *text); |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
228 |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
229 /** |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
230 * Closes a connection with an error. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
231 * |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
232 * @param gc The connection. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
233 * @param reason The error text. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
234 */ |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
235 void gaim_connection_error(GaimConnection *gc, const char *reason); |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
236 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
237 /*@}*/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
238 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
239 /**************************************************************************/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
240 /** @name Connections API */ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
241 /**************************************************************************/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
242 /*@{*/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
243 |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
244 /** |
5563 | 245 * Disconnects from all connections. |
246 */ | |
247 void gaim_connections_disconnect_all(void); | |
248 | |
249 /** | |
250 * Returns a list of all active connections. | |
251 * | |
252 * @return A list of all active connections. | |
253 */ | |
254 GList *gaim_connections_get_all(void); | |
255 | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
256 /** |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
257 * Returns a list of all connections in the process of connecting. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
258 * |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
259 * @return A list of connecting connections. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
260 */ |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
261 GList *gaim_connections_get_connecting(void); |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
262 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
263 /*@}*/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
264 |
5563 | 265 /**************************************************************************/ |
7122
b90c94620d1c
[gaim-migrate @ 7689]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
266 /** @name UI Registration Functions */ |
5563 | 267 /**************************************************************************/ |
268 /*@{*/ | |
269 | |
270 /** | |
271 * Sets the UI operations structure to be used for connections. | |
272 * | |
273 * @param ops The UI operations structure. | |
274 */ | |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6982
diff
changeset
|
275 void gaim_connections_set_ui_ops(GaimConnectionUiOps *ops); |
5563 | 276 |
277 /** | |
278 * Returns the UI operations structure used for connections. | |
279 * | |
280 * @return The UI operations structure in use. | |
281 */ | |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6982
diff
changeset
|
282 GaimConnectionUiOps *gaim_connections_get_ui_ops(void); |
5563 | 283 |
284 /*@}*/ | |
285 | |
6488
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
286 /**************************************************************************/ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
287 /** @name Connections Subsystem */ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
288 /**************************************************************************/ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
289 /*@{*/ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
290 |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
291 /** |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
292 * Initializes the connections subsystem. |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
293 */ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
294 void gaim_connections_init(void); |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
295 |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
296 /** |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
297 * Uninitializes the connections subsystem. |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
298 */ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
299 void gaim_connections_uninit(void); |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
300 |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
301 /** |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
302 * Returns the handle to the connections subsystem. |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
303 * |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
304 * @return The connections subsystem handle. |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
305 */ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
306 void *gaim_connections_get_handle(void); |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
307 |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
308 /*@}*/ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
309 |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
310 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
311 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
312 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
313 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
314 |
5563 | 315 #endif /* _GAIM_CONNECTION_H_ */ |