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