Mercurial > pidgin.yaz
annotate src/connection.h @ 8472:6d1c5321c55e
[gaim-migrate @ 9205]
Added a new Get Info icon, to replace the old one we use, which is actually
an alias for the stock Find image. The new Get Info icon comes from the
gnome icons.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Fri, 19 Mar 2004 09:33:35 +0000 |
parents | 87bd4d4ff499 |
children | cc2ce209cc46 |
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'. */ |
41 GAIM_CONNECTION_NO_BGCOLOR = 0x0002, /**< Connection does not send/recieve | |
42 background colors. */ | |
43 GAIM_CONNECTION_AUTO_RESP = 0x0004 /**< Send auto responses when away. */ | |
6622 | 44 } GaimConnectionFlags; |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5733
diff
changeset
|
45 |
5563 | 46 typedef enum |
47 { | |
48 GAIM_DISCONNECTED = 0, /**< Disconnected. */ | |
49 GAIM_CONNECTED, /**< Connected. */ | |
50 GAIM_CONNECTING /**< Connecting. */ | |
51 | |
52 } GaimConnectionState; | |
53 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
54 #include "account.h" |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
55 #include "plugin.h" |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
56 |
5563 | 57 typedef struct |
58 { | |
59 void (*connect_progress)(GaimConnection *gc, const char *text, | |
60 size_t step, size_t step_count); | |
61 void (*connected)(GaimConnection *gc); | |
6460
ff4551719cc7
[gaim-migrate @ 6969]
Christian Hammond <chipx86@chipx86.com>
parents:
6393
diff
changeset
|
62 void (*disconnected)(GaimConnection *gc); |
5571
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
63 void (*notice)(GaimConnection *gc, const char *text); |
6460
ff4551719cc7
[gaim-migrate @ 6969]
Christian Hammond <chipx86@chipx86.com>
parents:
6393
diff
changeset
|
64 void (*report_disconnect)(GaimConnection *gc, const char *text); |
5563 | 65 |
66 } GaimConnectionUiOps; | |
67 | |
68 struct _GaimConnection | |
69 { | |
70 GaimPlugin *prpl; /**< The protocol plugin. */ | |
6622 | 71 GaimConnectionFlags flags; /**< Connection flags. */ |
5563 | 72 |
73 GaimConnectionState state; /**< The connection state. */ | |
74 | |
75 GaimAccount *account; /**< The account being connected to. */ | |
76 int inpa; /**< The input watcher. */ | |
77 | |
78 GSList *buddy_chats; /**< A list of active chats. */ | |
79 void *proto_data; /**< Protocol-specific data. */ | |
80 | |
81 char *display_name; /**< The name displayed. */ | |
82 guint keep_alive; /**< Keep-alive. */ | |
83 | |
84 guint idle_timer; /**< The idle timer. */ | |
85 time_t login_time; /**< Time of login. */ | |
86 time_t login_time_official; /**< Official time of login. */ | |
87 time_t last_sent_time; /**< The time something was last sent. */ | |
88 int is_idle; /**< Idle state of the connection. */ | |
89 | |
90 char *away; /**< The current away message, or NULL */ | |
91 char *away_state; /**< The last away type. */ | |
92 gboolean is_auto_away; /**< Whether or not it's auto-away. */ | |
93 | |
94 int evil; /**< Warning level for AIM (why is | |
95 this here?) */ | |
96 | |
8430 | 97 gboolean wants_to_die; /**< Wants to Die state. This is set |
98 when the user chooses to sign off, | |
99 or when the protocol is | |
100 disconnected and should not be | |
101 automatically reconnected | |
102 (incorrect password, etc.) */ | |
6393 | 103 guint disconnect_timeout; /**< Timer used for nasty stack tricks */ |
5563 | 104 }; |
105 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
106 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
107 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
108 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
109 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
110 /**************************************************************************/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
111 /** @name Connection API */ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
112 /**************************************************************************/ |
6488
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
113 /*@{*/ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
114 |
5563 | 115 /** |
116 * Creates a connection to the specified account. | |
117 * | |
118 * @param account The account the connection should be connecting to. | |
119 * | |
120 * @return The gaim connection. | |
121 */ | |
122 GaimConnection *gaim_connection_new(GaimAccount *account); | |
123 | |
124 /** | |
125 * Destroys and closes a gaim connection. | |
126 * | |
127 * @param gc The gaim connection to destroy. | |
128 */ | |
129 void gaim_connection_destroy(GaimConnection *gc); | |
130 | |
131 /** | |
132 * Signs a connection on. | |
133 * | |
134 * @param gc The connection to sign on. | |
135 * | |
136 * @see gaim_connection_disconnect() | |
137 */ | |
138 void gaim_connection_connect(GaimConnection *gc); | |
139 | |
140 /** | |
6581 | 141 * Registers a connection. |
142 * | |
143 * @param gc The connection to register. | |
144 */ | |
145 void gaim_connection_register(GaimConnection *gc); | |
146 | |
147 /** | |
5563 | 148 * Signs a connection off. |
6583
e07c66073b6d
[gaim-migrate @ 7105]
Christian Hammond <chipx86@chipx86.com>
parents:
6581
diff
changeset
|
149 * |
5563 | 150 * @param gc The connection to sign off. |
151 * | |
152 * @see gaim_connection_connect() | |
153 */ | |
154 void gaim_connection_disconnect(GaimConnection *gc); | |
155 | |
156 /** | |
157 * Sets the connection state. | |
158 * | |
159 * @param gc The connection. | |
160 * @param state The connection state. | |
161 */ | |
162 void gaim_connection_set_state(GaimConnection *gc, GaimConnectionState state); | |
163 | |
164 /** | |
165 * Sets the connection's account. | |
166 * | |
167 * @param gc The connection. | |
168 * @param account The account. | |
169 */ | |
170 void gaim_connection_set_account(GaimConnection *gc, GaimAccount *account); | |
171 | |
172 /** | |
173 * Sets the connection's displayed name. | |
174 * | |
175 * @param gc The connection. | |
176 * @param name The displayed name. | |
177 */ | |
178 void gaim_connection_set_display_name(GaimConnection *gc, const char *name); | |
179 | |
180 /** | |
181 * Returns the connection state. | |
182 * | |
183 * @param gc The connection. | |
184 * | |
185 * @return The connection state. | |
186 */ | |
187 GaimConnectionState gaim_connection_get_state(const GaimConnection *gc); | |
188 | |
189 /** | |
190 * Returns the connection's account. | |
191 * | |
192 * @param gc The connection. | |
193 * | |
194 * @return The connection's account. | |
195 */ | |
196 GaimAccount *gaim_connection_get_account(const GaimConnection *gc); | |
197 | |
198 /** | |
199 * Returns the connection's displayed name. | |
200 * | |
201 * @param gc The connection. | |
202 * | |
203 * @return The connection's displayed name. | |
204 */ | |
205 const char *gaim_connection_get_display_name(const GaimConnection *gc); | |
206 | |
207 /** | |
208 * Updates the connection progress. | |
209 * | |
210 * @param gc The connection. | |
211 * @param text Information on the current step. | |
212 * @param step The current step. | |
213 * @param count The total number of steps. | |
214 */ | |
215 void gaim_connection_update_progress(GaimConnection *gc, const char *text, | |
216 size_t step, size_t count); | |
217 | |
218 /** | |
5571
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
219 * Displays a connection-specific notice. |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
220 * |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
221 * @param gc The connection. |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
222 * @param text The notice text. |
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 void gaim_connection_notice(GaimConnection *gc, const char *text); |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
225 |
113090160626
[gaim-migrate @ 5973]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
226 /** |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
227 * Closes a connection with an error. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
228 * |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
229 * @param gc The connection. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
230 * @param reason The error text. |
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 void gaim_connection_error(GaimConnection *gc, const char *reason); |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
233 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
234 /*@}*/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
235 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
236 /**************************************************************************/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
237 /** @name Connections API */ |
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 |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
241 /** |
5563 | 242 * Disconnects from all connections. |
243 */ | |
244 void gaim_connections_disconnect_all(void); | |
245 | |
246 /** | |
247 * Returns a list of all active connections. | |
248 * | |
249 * @return A list of all active connections. | |
250 */ | |
251 GList *gaim_connections_get_all(void); | |
252 | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
253 /** |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
254 * Returns a list of all connections in the process of connecting. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
255 * |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
256 * @return A list of connecting connections. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
257 */ |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
258 GList *gaim_connections_get_connecting(void); |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
259 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
260 /*@}*/ |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
261 |
5563 | 262 /**************************************************************************/ |
7122
b90c94620d1c
[gaim-migrate @ 7689]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
263 /** @name UI Registration Functions */ |
5563 | 264 /**************************************************************************/ |
265 /*@{*/ | |
266 | |
267 /** | |
268 * Sets the UI operations structure to be used for connections. | |
269 * | |
270 * @param ops The UI operations structure. | |
271 */ | |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6982
diff
changeset
|
272 void gaim_connections_set_ui_ops(GaimConnectionUiOps *ops); |
5563 | 273 |
274 /** | |
275 * Returns the UI operations structure used for connections. | |
276 * | |
277 * @return The UI operations structure in use. | |
278 */ | |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6982
diff
changeset
|
279 GaimConnectionUiOps *gaim_connections_get_ui_ops(void); |
5563 | 280 |
281 /*@}*/ | |
282 | |
6488
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
283 /**************************************************************************/ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
284 /** @name Connections Subsystem */ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
285 /**************************************************************************/ |
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 |
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 * Initializes the connections subsystem. |
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 void gaim_connections_init(void); |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
292 |
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 * Uninitializes the connections subsystem. |
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 void gaim_connections_uninit(void); |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
297 |
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 * Returns the handle to the connections subsystem. |
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 * @return The connections subsystem handle. |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
302 */ |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
303 void *gaim_connections_get_handle(void); |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
304 |
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 |
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
307 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
308 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
309 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
310 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
311 |
5563 | 312 #endif /* _GAIM_CONNECTION_H_ */ |