1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
/**
* @file switchboard.h MSN switchboard functions
*
* gaim
*
* Gaim is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef _MSN_SWITCHBOARD_H_
#define _MSN_SWITCHBOARD_H_
typedef struct _MsnSwitchBoard MsnSwitchBoard;
#include "conversation.h"
#include "msg.h"
#include "user.h"
#include "servconn.h"
#include "slplink.h"
/**
* A switchboard error.
*/
typedef enum
{
MSN_SB_ERROR_NONE, /**< No error. */
MSN_SB_ERROR_CAL, /**< The user could not join (answer the call). */
MSN_SB_ERROR_OFFLINE, /**< The account is offline. */
MSN_SB_ERROR_USER_OFFLINE, /**< The user to call is offline. */
MSN_SB_ERROR_CONNECTION, /**< There was a connection error. */
MSN_SB_ERROR_TOO_FAST, /**< We are sending too fast */
MSN_SB_ERROR_UNKNOWN /**< An unknown error occurred. */
} MsnSBErrorType;
/**
* A switchboard flag.
*/
typedef enum
{
MSN_SB_FLAG_IM = 0x01, /**< This switchboard is being used for a conversation. */
MSN_SB_FLAG_FT = 0x02, /**< This switchboard is being used for file transfer. */
} MsnSBFlag;
/**
* A switchboard.
*
* A place where a bunch of users send messages to the rest of the users.
*/
struct _MsnSwitchBoard
{
MsnSession *session;
MsnServConn *servconn;
MsnCmdProc *cmdproc;
char *im_user;
MsnSBFlag flag;
char *auth_key;
char *session_id;
GaimConversation *conv; /**< The conversation that displays the
messages of this switchboard, or @c NULL if
this is a helper switchboard. */
gboolean empty; /**< A flag that states if the swithcboard has no
users in it. */
gboolean invited; /**< A flag that states if we were invited to the
switchboard. */
gboolean ready; /**< A flag that states if this switchboard is
ready to be used. */
gboolean closed; /**< A flag that states if the switchboard has
been closed by the user. */
gboolean destroying; /**< A flag that states if the switchboard is
alredy on the process of destruction. */
int current_users;
int total_users;
GList *users;
int chat_id;
GQueue *msg_queue; /**< Queue of messages to send. */
GList *ack_list; /**< List of messages waiting for an ack. */
MsnSBErrorType error; /**< The error that occurred in this switchboard
(if applicable). */
GList *slplinks; /**< The list of slplinks that are using this switchboard. */
};
/**
* Initialize the variables for switchboard creation.
*/
void msn_switchboard_init(void);
/**
* Destroy the variables for switchboard creation.
*/
void msn_switchboard_end(void);
/**
* Creates a new switchboard.
*
* @param session The MSN session.
*
* @return The new switchboard.
*/
MsnSwitchBoard *msn_switchboard_new(MsnSession *session);
/**
* Destroys a switchboard.
*
* @param swboard The switchboard to destroy.
*/
void msn_switchboard_destroy(MsnSwitchBoard *swboard);
/**
* Sets the auth key the switchboard must use when connecting.
*
* @param swboard The switchboard.
* @param key The auth key.
*/
void msn_switchboard_set_auth_key(MsnSwitchBoard *swboard, const char *key);
/**
* Returns the auth key the switchboard must use when connecting.
*
* @param swboard The switchboard.
*
* @return The auth key.
*/
const char *msn_switchboard_get_auth_key(MsnSwitchBoard *swboard);
/**
* Sets the session ID the switchboard must use when connecting.
*
* @param swboard The switchboard.
* @param id The session ID.
*/
void msn_switchboard_set_session_id(MsnSwitchBoard *swboard, const char *id);
/**
* Returns the session ID the switchboard must use when connecting.
*
* @param swboard The switchboard.
*
* @return The session ID.
*/
const char *msn_switchboard_get_session_id(MsnSwitchBoard *swboard);
/**
* Sets whether or not we were invited to this switchboard.
*
* @param swboard The switchboard.
* @param invite @c TRUE if invited, @c FALSE otherwise.
*/
void msn_switchboard_set_invited(MsnSwitchBoard *swboard, gboolean invited);
/**
* Returns whether or not we were invited to this switchboard.
*
* @param swboard The switchboard.
*
* @return @c TRUE if invited, @c FALSE otherwise.
*/
gboolean msn_switchboard_is_invited(MsnSwitchBoard *swboard);
/**
* Connects to a switchboard.
*
* @param swboard The switchboard.
* @param host The switchboard server host.
* @param port The switcbharod server port.
*
* @return @c TRUE if able to connect, or @c FALSE otherwise.
*/
gboolean msn_switchboard_connect(MsnSwitchBoard *swboard,
const char *host, int port);
/**
* Disconnects from a switchboard.
*
* @param swboard The switchboard to disconnect from.
*/
void msn_switchboard_disconnect(MsnSwitchBoard *swboard);
/**
* Closes the switchboard.
*
* Called when a conversation is closed.
*
* @param swboard The switchboard to close.
*/
void msn_switchboard_close(MsnSwitchBoard *swboard);
/**
* Release a switchboard from a certain function.
*
* @param swboard The switchboard to release.
* @param flag The flag that states the function.
*
* @return @c TRUE if the switchboard was closed, @c FALSE otherwise.
*/
gboolean msn_switchboard_release(MsnSwitchBoard *swboard, MsnSBFlag flag);
/**
* Returns whether or not we currently can send a message through this
* switchboard.
*
* @param swboard The switchboard.
*
* @return @c TRUE if a message can be sent, @c FALSE otherwise.
*/
gboolean msn_switchboard_can_send(MsnSwitchBoard *swboard);
/**
* Sends a message through this switchboard.
*
* @param swboard The switchboard.
* @param msg The message.
* @param queue A flag that states if we want this message to be queued (in
* the case it cannot currently be sent).
*
* @return @c TRUE if a message can be sent, @c FALSE otherwise.
*/
void msn_switchboard_send_msg(MsnSwitchBoard *swboard, MsnMessage *msg,
gboolean queue);
gboolean msn_switchboard_chat_leave(MsnSwitchBoard *swboard);
gboolean msn_switchboard_chat_invite(MsnSwitchBoard *swboard, const char *who);
void msn_switchboard_request(MsnSwitchBoard *swboard);
void msn_switchboard_request_add_user(MsnSwitchBoard *swboard, const char *user);
/**
* Processes peer to peer messages.
*
* @param cmdproc The command processor.
* @param msg The message.
*/
void msn_p2p_msg(MsnCmdProc *cmdproc, MsnMessage *msg);
/**
* Processes emoticon messages.
*
* @param cmdproc The command processor.
* @param msg The message.
*/
void msn_emoticon_msg(MsnCmdProc *cmdproc, MsnMessage *msg);
/**
* Processes INVITE messages.
*
* @param cmdproc The command processor.
* @param msg The message.
*/
void msn_invite_msg(MsnCmdProc *cmdproc, MsnMessage *msg);
#endif /* _MSN_SWITCHBOARD_H_ */
|
