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