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