File: msg.h

package info (click to toggle)
pidgin-nateon 0.0.0.svn147-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, jessie, jessie-kfreebsd, sid, stretch, wheezy
  • size: 2,616 kB
  • ctags: 779
  • sloc: sh: 9,081; ansic: 6,639; makefile: 110
file content (348 lines) | stat: -rw-r--r-- 8,357 bytes parent folder | download | duplicates (3)
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
/**
 * @file msg.h Message functions
 *
 * purple
 *
 * Purple 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 _NATEON_MSG_H_
#define _NATEON_MSG_H_

typedef struct _NateonMessage NateonMessage;

#include "session.h"
//#include "user.h"

#include "command.h"
#include "transaction.h"

//typedef void (*NateonMsgCb)(NateonMessage *, void *data);

///*
//typedef enum
//{
//	NATEON_MSG_NORMAL,
//	NATEON_MSG_SLP_SB,
//	NATEON_MSG_SLP_DC
//
//} NateonMsgType;
//*/

typedef enum
{
	NATEON_MSG_UNKNOWN,
	NATEON_MSG_TEXT,
	NATEON_MSG_TYPING,
//	NATEON_MSG_CAPS,
//	NATEON_MSG_SLP,
//	NATEON_MSG_NUDGE

} NateonMsgType;

typedef enum
{
	NATEON_MSG_ERROR_NONE, /**< No error. */
	NATEON_MSG_ERROR_TIMEOUT, /**< The message timedout. */
	NATEON_MSG_ERROR_NAK, /**< The message could not be sent. */
	NATEON_MSG_ERROR_SB, /**< The error comes from the switchboard. */
	NATEON_MSG_ERROR_UNKNOWN /**< An unknown error occurred. */
} NateonMsgErrorType;

//typedef struct
//{
//	guint32 session_id;
//	guint32 id;
//	guint64 offset;
//	guint64 total_size;
//	guint32 length;
//	guint32 flags;
//	guint32 ack_id;
//	guint32 ack_sub_id;
//	guint64 ack_size;
//
//} NateonSlpHeader;
//
//typedef struct
//{
//	guint32 value;
//
//} NateonSlpFooter;

/**
 * A message.
 */
struct _NateonMessage
{
	size_t ref_count;           /**< The reference count.       */

	NateonMsgType type;

//	gboolean nateonslp_message;
//
//	char *remote_user;
//	char flag;
//
//	char *content_type;
//	char *charset;
	char *body;
	gsize body_len;

//	NateonSlpHeader nateonslp_header;
//	NateonSlpFooter nateonslp_footer;
//
//	GHashTable *attr_table;
//	GList *attr_list;

	gboolean ack_ref;           /**< A flag that states if this message has
								  been ref'ed for using it in a callback. */

//	NateonCommand *cmd;
	NateonTransaction *trans;

//	NateonMsgCb ack_cb; /**< The callback to call when we receive an ACK of this
//					   message. */
//	NateonMsgCb nak_cb; /**< The callback to call when we receive a NAK of this
//					   message. */
//	void *ack_data; /**< The data used by callbacks. */
//
//	NateonMsgErrorType error; /**< The error of the message. */
};

/**
 * Creates a new, empty message.
 *
 * @return A new message.
 */
NateonMessage *nateon_message_new(NateonMsgType type);

///**
// * Creates a new, empty NATEONSLP message.
// *
// * @return A new NATEONSLP message.
// */
//NateonMessage *nateon_message_new_nateonslp(void);
//
///**
// * Creates a new nudge message.
// *
// * @return A new nudge message.
// */
//NateonMessage *nateon_message_new_nudge(void);

/**
 * Creates a new plain message.
 *
 * @return A new plain message.
 */
NateonMessage *nateon_message_new_plain(const char *message);

///**
// * Creates a NATEONSLP ack message.
// *
// * @param acked_msg The message to acknowledge.
// *
// * @return A new NATEONSLP ack message.
// */
//NateonMessage *nateon_message_new_nateonslp_ack(NateonMessage *acked_msg);
//
///**
// * Creates a new message based off a command.
// *
// * @param session The NATEON session.
// * @param cmd     The command.
// *
// * @return The new message.
// */
//NateonMessage *nateon_message_new_from_cmd(NateonSession *session, NateonCommand *cmd);
//
///**
// * Parses the payload of a message.
// *
// * @param msg         The message.
// * @param payload     The payload.
// * @param payload_len The length of the payload.
// */
//void nateon_message_parse_payload(NateonMessage *msg, const char *payload,
//							   size_t payload_len);

/**
 * Destroys a message.
 *
 * @param msg The message to destroy.
 */
void nateon_message_destroy(NateonMessage *msg);

/**
 * Increments the reference count on a message.
 *
 * @param msg The message.
 *
 * @return @a msg
 */
NateonMessage *nateon_message_ref(NateonMessage *msg);

/**
 * Decrements the reference count on a message.
 *
 * This will destroy the structure if the count hits 0.
 *
 * @param msg The message.
 *
 * @return @a msg, or @c NULL if the new count is 0.
 */
NateonMessage *nateon_message_unref(NateonMessage *msg);

///**
// * Generates the payload data of a message.
// *
// * @param msg      The message.
// * @param ret_size The returned size of the payload.
// *
// * @return The payload data of the message.
// */
//char *nateon_message_gen_payload(NateonMessage *msg, size_t *ret_size);
//
///**
// * Sets the flag for an outgoing message.
// *
// * @param msg  The message.
// * @param flag The flag.
// */
//void nateon_message_set_flag(NateonMessage *msg, char flag);
//
///**
// * Returns the flag for an outgoing message.
// *
// * @param msg The message.
// *
// * @return The flag.
// */
//char nateon_message_get_flag(const NateonMessage *msg);
//
//#if 0
///**
// * Sets the body of a message.
// *
// * @param msg  The message.
// * @param body The body of the message.
// */
//void nateon_message_set_body(NateonMessage *msg, const char *body);
//
///**
// * Returns the body of the message.
// *
// * @param msg The message.
// *
// * @return The body of the message.
// */
//const char *nateon_message_get_body(const NateonMessage *msg);
//#endif
/**
 * Sets the binary content of the message.
 *
 * @param msg  The message.
 * @param data The binary data.
 * @param len  The length of the data.
 */
void nateon_message_set_bin_data(NateonMessage *msg, const void *data, size_t len);

///**
// * Returns the binary content of the message.
// *
// * @param msg The message.
// * @param len The returned length of the data.
// *
// * @return The binary data.
// */
//const void *nateon_message_get_bin_data(const NateonMessage *msg, size_t *len);
//
///**
// * Sets the content type in a message.
// *
// * @param msg  The message.
// * @param type The content-type.
// */
//void nateon_message_set_content_type(NateonMessage *msg, const char *type);
//
///**
// * Returns the content type in a message.
// *
// * @param msg The message.
// *
// * @return The content-type.
// */
//const char *nateon_message_get_content_type(const NateonMessage *msg);
//
///**
// * Sets the charset in a message.
// *
// * @param msg     The message.
// * @param charset The charset.
// */
//void nateon_message_set_charset(NateonMessage *msg, const char *charset);
//
///**
// * Returns the charset in a message.
// *
// * @param msg The message.
// *
// * @return The charset.
// */
//const char *nateon_message_get_charset(const NateonMessage *msg);
//
///**
// * Sets an attribute in a message.
// *
// * @param msg   The message.
// * @param attr  The attribute name.
// * @param value The attribute value.
// */
//void nateon_message_set_attr(NateonMessage *msg, const char *attr,
//						  const char *value);
//
///**
// * Returns an attribute from a message.
// *
// * @param msg  The message.
// * @param attr The attribute.
// *
// * @return The value, or @c NULL if not found.
// */
//const char *nateon_message_get_attr(const NateonMessage *msg, const char *attr);
//
///**
// * Parses the body and returns it in the form of a hashtable.
// *
// * @param msg The message.
// *
// * @return The resulting hashtable.
// */
//GHashTable *nateon_message_get_hashtable_from_body(const NateonMessage *msg);
//
//void nateon_message_show_readable(NateonMessage *msg, const char *info,
//							   gboolean text_body);
//
//void nateon_message_parse_slp_body(NateonMessage *msg, const char *body,
//								size_t len);
//
//char *nateon_message_gen_slp_body(NateonMessage *msg, size_t *ret_size);
//
//char *nateon_message_to_string(NateonMessage *msg);

#endif /* _NATEON_MSG_H_ */