meanwhile 1.1.1
mw_common.h
Go to the documentation of this file.
1
2/*
3 Meanwhile - Unofficial Lotus Sametime Community Client Library
4 Copyright (C) 2004 Christopher (siege) O'Brien
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
10
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
15
16 You should have received a copy of the GNU Library General Public
17 License along with this library; if not, write to the Free
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19*/
20
21#ifndef _MW_COMMON_H
22#define _MW_COMMON_H
23
24
61#include <glib.h>
62
63
64#ifdef __cplusplus
65extern "C" {
66#endif
67
68
71struct mwPutBuffer;
72
75struct mwGetBuffer;
76
77
79struct mwOpaque {
80 gsize len;
81 guchar *data;
82};
83
84
85/* 8.3.6 Login Types */
86
118
119
120/* 8.2 Common Structures */
121/* 8.2.1 Login Info block */
122
124 char *login_id;
125 guint16 type;
126 char *user_id;
127 char *user_name;
128 char *community;
129 gboolean full;
130 char *desc;
131 guint32 ip_addr;
132 char *server_id;
133};
134
135
136/* 8.2.2 Private Info Block */
137
139 gboolean full;
140 char *id;
141 char *community;
142 char *name;
143};
144
145
147 gboolean deny;
148 guint32 count;
150};
151
152
153/* 8.3.5 User Status Types */
154
157
162
164};
165
166
167/* 8.2.3 User Status Block */
168
170 guint16 status;
171 guint32 time;
172 char *desc;
173};
174
175
176/* 8.2.4 ID Block */
177
178struct mwIdBlock {
179 char *user;
180 char *community;
181};
182
183
184/* 8.3.8.2 Awareness Presence Types */
185
186/* @todo move mwAwareType, mwAwareIdBlock and mwAwareSnapshot into the
187 aware service and out of common */
188
191 mwAware_USER = 0x0002,
192 mwAware_GROUP = 0x0003,
193 mwAware_SERVER = 0x0008,
194};
195
196
197/* 8.4.2 Awareness Messages */
198/* 8.4.2.1 Awareness ID Block */
199
201 guint16 type;
202 char *user;
203 char *community;
204};
205
206
207/* 8.4.2.4 Snapshot */
208
211 char *group;
212 gboolean online;
213 char *alt_id;
215 char *name;
216};
217
218
221 guint16 id;
222 struct mwOpaque info;
223};
224
225
228
229
232
233
235void mwPutBuffer_write(struct mwPutBuffer *b, gpointer data, gsize len);
236
237
240
241
243void mwPutBuffer_finalize(struct mwOpaque *to, struct mwPutBuffer *from);
244
245
248
249
255gsize mwGetBuffer_read(struct mwGetBuffer *b, gpointer mem, gsize len);
256
257
263gsize mwGetBuffer_advance(struct mwGetBuffer *b, gsize len);
264
265
269struct mwGetBuffer *mwGetBuffer_wrap(const struct mwOpaque *data);
270
271
274
275
279
280
283
284
287gboolean mwGetBuffer_error(struct mwGetBuffer *b);
288
289
297
298
299void guint16_put(struct mwPutBuffer *b, guint16 val);
300
301void guint16_get(struct mwGetBuffer *b, guint16 *val);
302
303guint16 guint16_peek(struct mwGetBuffer *b);
304
305
306void guint32_put(struct mwPutBuffer *b, guint32 val);
307
308void guint32_get(struct mwGetBuffer *b, guint32 *val);
309
310guint32 guint32_peek(struct mwGetBuffer *b);
311
312
313void gboolean_put(struct mwPutBuffer *b, gboolean val);
314
315void gboolean_get(struct mwGetBuffer *b, gboolean *val);
316
317gboolean gboolean_peek(struct mwGetBuffer *b);
318
319
320void mwString_put(struct mwPutBuffer *b, const char *str);
321
322void mwString_get(struct mwGetBuffer *b, char **str);
323
324
325void mwOpaque_put(struct mwPutBuffer *b, const struct mwOpaque *o);
326
327void mwOpaque_get(struct mwGetBuffer *b, struct mwOpaque *o);
328
329void mwOpaque_clear(struct mwOpaque *o);
330
331void mwOpaque_free(struct mwOpaque *o);
332
333void mwOpaque_clone(struct mwOpaque *to, const struct mwOpaque *from);
334
335
341
342
343void mwLoginInfo_put(struct mwPutBuffer *b, const struct mwLoginInfo *info);
344
345void mwLoginInfo_get(struct mwGetBuffer *b, struct mwLoginInfo *info);
346
348
349void mwLoginInfo_clone(struct mwLoginInfo *to, const struct mwLoginInfo *from);
350
351
352void mwUserItem_put(struct mwPutBuffer *b, const struct mwUserItem *user);
353
354void mwUserItem_get(struct mwGetBuffer *b, struct mwUserItem *user);
355
356void mwUserItem_clear(struct mwUserItem *user);
357
358void mwUserItem_clone(struct mwUserItem *to, const struct mwUserItem *from);
359
360
362 const struct mwPrivacyInfo *info);
363
364void mwPrivacyInfo_get(struct mwGetBuffer *b, struct mwPrivacyInfo *info);
365
367
369 const struct mwPrivacyInfo *from);
370
371
373 const struct mwUserStatus *stat);
374
375void mwUserStatus_get(struct mwGetBuffer *b, struct mwUserStatus *stat);
376
378
380 const struct mwUserStatus *from);
381
382
383void mwIdBlock_put(struct mwPutBuffer *b, const struct mwIdBlock *id);
384
385void mwIdBlock_get(struct mwGetBuffer *b, struct mwIdBlock *id);
386
387void mwIdBlock_clear(struct mwIdBlock *id);
388
390 const struct mwIdBlock *from);
391
392guint mwIdBlock_hash(const struct mwIdBlock *idb);
393
394gboolean mwIdBlock_equal(const struct mwIdBlock *a,
395 const struct mwIdBlock *b);
396
397
399 const struct mwAwareIdBlock *idb);
400
401void mwAwareIdBlock_get(struct mwGetBuffer *b, struct mwAwareIdBlock *idb);
402
404
406 const struct mwAwareIdBlock *from);
407
408guint mwAwareIdBlock_hash(const struct mwAwareIdBlock *a);
409
410gboolean mwAwareIdBlock_equal(const struct mwAwareIdBlock *a,
411 const struct mwAwareIdBlock *b);
412
413
415 struct mwAwareSnapshot *idb);
416
418
420 const struct mwAwareSnapshot *from);
421
422
424 const struct mwEncryptItem *item);
425
426void mwEncryptItem_get(struct mwGetBuffer *b, struct mwEncryptItem *item);
427
429
431
432
436#ifdef __cplusplus
437}
438#endif
439
440
441#endif /* _MW_COMMON_H */
void mwIdBlock_get(struct mwGetBuffer *b, struct mwIdBlock *id)
guint16 guint16_peek(struct mwGetBuffer *b)
void mwAwareIdBlock_put(struct mwPutBuffer *b, const struct mwAwareIdBlock *idb)
void mwPrivacyInfo_clone(struct mwPrivacyInfo *to, const struct mwPrivacyInfo *from)
void mwEncryptItem_get(struct mwGetBuffer *b, struct mwEncryptItem *item)
void guint32_get(struct mwGetBuffer *b, guint32 *val)
struct mwPutBuffer * mwPutBuffer_new(void)
allocate a new empty buffer
void mwIdBlock_put(struct mwPutBuffer *b, const struct mwIdBlock *id)
void mwIdBlock_clear(struct mwIdBlock *id)
void mwLoginInfo_clone(struct mwLoginInfo *to, const struct mwLoginInfo *from)
void mwAwareIdBlock_get(struct mwGetBuffer *b, struct mwAwareIdBlock *idb)
guint mwIdBlock_hash(const struct mwIdBlock *idb)
gsize mwGetBuffer_remaining(struct mwGetBuffer *b)
count of remaining available bytes
void mwOpaque_get(struct mwGetBuffer *b, struct mwOpaque *o)
mwAwareType
type codes for mwAwareIdBlock
Definition mw_common.h:190
@ mwAware_USER
a single user
Definition mw_common.h:191
@ mwAware_GROUP
a group
Definition mw_common.h:192
@ mwAware_SERVER
a server
Definition mw_common.h:193
void mwOpaque_clear(struct mwOpaque *o)
void mwUserStatus_clear(struct mwUserStatus *stat)
void mwUserItem_get(struct mwGetBuffer *b, struct mwUserItem *user)
struct mwGetBuffer * mwGetBuffer_wrap(const struct mwOpaque *data)
allocate a new buffer backed by the given data.
void gboolean_get(struct mwGetBuffer *b, gboolean *val)
void mwLoginInfo_get(struct mwGetBuffer *b, struct mwLoginInfo *info)
void mwPutBuffer_finalize(struct mwOpaque *to, struct mwPutBuffer *from)
move the buffer's data into an opaque, destroy the buffer
guint32 guint32_peek(struct mwGetBuffer *b)
void mwPutBuffer_write(struct mwPutBuffer *b, gpointer data, gsize len)
write raw data to the put buffer
void mwString_put(struct mwPutBuffer *b, const char *str)
void mwPrivacyInfo_clear(struct mwPrivacyInfo *info)
void mwGetBuffer_reset(struct mwGetBuffer *b)
reset the buffer to the very beginning.
void mwLoginInfo_clear(struct mwLoginInfo *info)
void mwUserStatus_get(struct mwGetBuffer *b, struct mwUserStatus *stat)
void mwUserItem_clone(struct mwUserItem *to, const struct mwUserItem *from)
gboolean mwIdBlock_equal(const struct mwIdBlock *a, const struct mwIdBlock *b)
void mwIdBlock_clone(struct mwIdBlock *to, const struct mwIdBlock *from)
void mwAwareSnapshot_clone(struct mwAwareSnapshot *to, const struct mwAwareSnapshot *from)
void mwGetBuffer_free(struct mwGetBuffer *b)
destroy the buffer
void mwUserItem_put(struct mwPutBuffer *b, const struct mwUserItem *user)
void mwEncryptItem_put(struct mwPutBuffer *b, const struct mwEncryptItem *item)
mwStatusType
Definition mw_common.h:155
@ mwStatus_BUSY
Definition mw_common.h:161
@ mwStatus_ACTIVE
Definition mw_common.h:158
@ mwStatus_MASK_MOBILE
Definition mw_common.h:163
@ mwStatus_OFFLINE
Definition mw_common.h:156
@ mwStatus_AWAY
Definition mw_common.h:160
@ mwStatus_IDLE
Definition mw_common.h:159
gboolean gboolean_peek(struct mwGetBuffer *b)
void mwAwareSnapshot_clear(struct mwAwareSnapshot *idb)
void mwUserStatus_clone(struct mwUserStatus *to, const struct mwUserStatus *from)
void mwOpaque_free(struct mwOpaque *o)
void mwUserItem_clear(struct mwUserItem *user)
mwLoginType
The type of login.
Definition mw_common.h:93
@ mwLogin_PMR_ALERT
Definition mw_common.h:113
@ mwLogin_LIB
official Lotus binary library
Definition mw_common.h:94
@ mwLogin_NOTES_7_0
Definition mw_common.h:104
@ mwLogin_LINKS
official Sametime Links toolkit
Definition mw_common.h:98
@ mwLogin_SANITY
Definition mw_common.h:111
@ mwLogin_JAVA_WEB
official Lotus Java applet
Definition mw_common.h:95
@ mwLogin_NOTESBUDDY_4_14
0xff00 mask?
Definition mw_common.h:108
@ mwLogin_NOTES_6_5
Definition mw_common.h:101
@ mwLogin_ICT
Definition mw_common.h:105
@ mwLogin_NOTES_7_0_beta
Definition mw_common.h:103
@ mwLogin_NOTESBUDDY_4_15
Definition mw_common.h:109
@ mwLogin_MEANWHILE
Meanwhile library.
Definition mw_common.h:116
@ mwLogin_NOTESBUDDY_4_16
Definition mw_common.h:110
@ mwLogin_TRILLIAN
http://sf.net/st-plugin/
Definition mw_common.h:114
@ mwLogin_NOTES_6_5_3
Definition mw_common.h:102
@ mwLogin_ICT_SIP
Definition mw_common.h:107
@ mwLogin_ICT_1_7_8_2
Definition mw_common.h:106
@ mwLogin_TRILLIAN_IBM
Definition mw_common.h:115
@ mwLogin_ST_PERL
Definition mw_common.h:112
@ mwLogin_BINARY
official Lotus binary application
Definition mw_common.h:96
@ mwLogin_JAVA_APP
official Lotus Java application
Definition mw_common.h:97
gboolean mwGetBuffer_error(struct mwGetBuffer *b)
TRUE if an error occurred while reading a basic type from this buffer.
void mwEncryptItem_clear(struct mwEncryptItem *item)
void guint32_put(struct mwPutBuffer *b, guint32 val)
void mwString_get(struct mwGetBuffer *b, char **str)
void mwOpaque_clone(struct mwOpaque *to, const struct mwOpaque *from)
void guint16_get(struct mwGetBuffer *b, guint16 *val)
void mwEncryptItem_free(struct mwEncryptItem *item)
void mwPrivacyInfo_get(struct mwGetBuffer *b, struct mwPrivacyInfo *info)
void mwUserStatus_put(struct mwPutBuffer *b, const struct mwUserStatus *stat)
void mwPrivacyInfo_put(struct mwPutBuffer *b, const struct mwPrivacyInfo *info)
gsize mwGetBuffer_advance(struct mwGetBuffer *b, gsize len)
skip len bytes in the get buffer.
void mwAwareIdBlock_clone(struct mwAwareIdBlock *to, const struct mwAwareIdBlock *from)
void mwLoginInfo_put(struct mwPutBuffer *b, const struct mwLoginInfo *info)
struct mwGetBuffer * mwGetBuffer_new(struct mwOpaque *data)
allocate a new buffer with a copy of the given data
void mwPutBuffer_free(struct mwPutBuffer *b)
destroy the buffer
void guint16_put(struct mwPutBuffer *b, guint16 val)
gsize mwGetBuffer_read(struct mwGetBuffer *b, gpointer mem, gsize len)
read len bytes of raw data from the get buffer into mem.
void mwAwareSnapshot_get(struct mwGetBuffer *b, struct mwAwareSnapshot *idb)
void mwAwareIdBlock_clear(struct mwAwareIdBlock *idb)
void gboolean_put(struct mwPutBuffer *b, gboolean val)
void mwOpaque_put(struct mwPutBuffer *b, const struct mwOpaque *o)
guint mwAwareIdBlock_hash(const struct mwAwareIdBlock *a)
gboolean mwAwareIdBlock_equal(const struct mwAwareIdBlock *a, const struct mwAwareIdBlock *b)
Definition mw_common.h:200
guint16 type
Definition mw_common.h:201
char * user
user id
Definition mw_common.h:202
char * community
community id (NULL for same community)
Definition mw_common.h:203
Definition mw_common.h:209
struct mwUserStatus status
status of this user
Definition mw_common.h:214
char * alt_id
alternate ID, often same as id.user
Definition mw_common.h:213
char * group
group this id belongs to
Definition mw_common.h:211
char * name
Formatted version of ID.
Definition mw_common.h:215
struct mwAwareIdBlock id
Definition mw_common.h:210
gboolean online
is this user online?
Definition mw_common.h:212
encryption blocks
Definition mw_common.h:220
guint16 id
cipher identifier
Definition mw_common.h:221
struct mwOpaque info
cipher information
Definition mw_common.h:222
buffer to be read from
Definition mw_common.h:178
char * community
community id (NULL for same community)
Definition mw_common.h:180
char * user
user id (login id or empty for some services)
Definition mw_common.h:179
Definition mw_common.h:123
char * desc
implementation defined description
Definition mw_common.h:130
guint16 type
Definition mw_common.h:125
char * user_id
community-unique ID of the user
Definition mw_common.h:126
char * server_id
unique ID of login's server
Definition mw_common.h:132
guint32 ip_addr
ip addr of the login
Definition mw_common.h:131
char * user_name
name of user (nick name, full name, etc)
Definition mw_common.h:127
gboolean full
if FALSE, following fields non-existant
Definition mw_common.h:129
char * community
community name (usually domain name)
Definition mw_common.h:128
char * login_id
community-unique ID of the login
Definition mw_common.h:124
A length of binary data, not null-terminated.
Definition mw_common.h:79
guchar * data
data, normally with no NULL termination
Definition mw_common.h:81
gsize len
length of data.
Definition mw_common.h:80
Definition mw_common.h:146
struct mwUserItem * users
the users list
Definition mw_common.h:149
guint32 count
count of users
Definition mw_common.h:148
gboolean deny
deny (true) or allow (false) users
Definition mw_common.h:147
buffer to be written to
Definition mw_common.h:138
char * id
user id
Definition mw_common.h:140
char * name
user name
Definition mw_common.h:142
gboolean full
if FALSE, don't include name
Definition mw_common.h:139
char * community
community
Definition mw_common.h:141
Definition mw_common.h:169
guint32 time
last status change time in seconds
Definition mw_common.h:171
guint16 status
Definition mw_common.h:170
char * desc
status description
Definition mw_common.h:172