10969
|
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_SRVC_AWARE_H
|
|
22 #define _MW_SRVC_AWARE_H
|
|
23
|
|
24
|
|
25 #include "mw_common.h"
|
|
26
|
|
27
|
|
28 /** @file mw_srvc_aware.h
|
|
29
|
|
30 The aware service...
|
|
31 */
|
|
32
|
|
33
|
|
34 /** Type identifier for the aware service */
|
|
35 #define SERVICE_AWARE 0x00000011
|
|
36
|
|
37
|
|
38 /** @struct mwServiceAware
|
|
39
|
|
40 Instance of an Aware Service. The members of this structure are
|
|
41 not made available. Accessing the parts of an aware service should
|
|
42 be performed through the appropriate functions. Note that
|
|
43 instances of this structure can be safely cast to a mwService.
|
|
44 */
|
|
45 struct mwServiceAware;
|
|
46
|
|
47
|
|
48 /** @struct mwAwareList
|
|
49
|
|
50 Instance of an Aware List. The members of this structure are not
|
|
51 made available. Access to the parts of an aware list should be
|
|
52 handled through the appropriate functions.
|
|
53 */
|
|
54 struct mwAwareList;
|
|
55
|
|
56
|
|
57 /** @struct mwAwareAttribute
|
|
58
|
|
59 Key/Opaque pair indicating an identity's attribute.
|
|
60 */
|
|
61 struct mwAwareAttribute;
|
|
62
|
|
63
|
|
64 /** Predefined keys appropriate for a mwAwareAttribute
|
|
65 */
|
|
66 enum mwAwareAttributeKeys {
|
|
67 mwAttribute_AV_PREFS_SET = 0x01, /**< A/V prefs specified, gboolean */
|
|
68 mwAttribute_MICROPHONE = 0x02, /**< has a microphone, gboolean */
|
|
69 mwAttribute_SPEAKERS = 0x03, /**< has speakers, gboolean */
|
|
70 mwAttribute_VIDEO_CAMERA = 0x04, /**< has a video camera, gboolean */
|
|
71 mwAttribute_FILE_TRANSFER = 0x06, /**< supports file transfers, gboolean */
|
|
72 };
|
|
73
|
|
74
|
|
75 typedef void (*mwAwareAttributeHandler)
|
|
76 (struct mwServiceAware *srvc,
|
|
77 struct mwAwareAttribute *attrib);
|
|
78
|
|
79
|
|
80 struct mwAwareHandler {
|
|
81 mwAwareAttributeHandler on_attrib;
|
|
82 void (*clear)(struct mwServiceAware *srvc);
|
|
83 };
|
|
84
|
|
85
|
|
86 /** Appropriate function type for the on-aware signal
|
|
87
|
|
88 @param list mwAwareList emiting the signal
|
|
89 @param id awareness status information
|
|
90 @param data user-specified data
|
|
91 */
|
|
92 typedef void (*mwAwareSnapshotHandler)
|
|
93 (struct mwAwareList *list,
|
|
94 struct mwAwareSnapshot *id);
|
|
95
|
|
96
|
|
97 /** Appropriate function type for the on-option signal. The option's
|
|
98 value may need to be explicitly loaded in some instances,
|
|
99 resulting in this handler being triggered again.
|
|
100
|
|
101 @param list mwAwareList emiting the signal
|
|
102 @param id awareness the attribute belongs to
|
|
103 @param attrib attribute
|
|
104 */
|
|
105 typedef void (*mwAwareIdAttributeHandler)
|
|
106 (struct mwAwareList *list,
|
|
107 struct mwAwareIdBlock *id,
|
|
108 struct mwAwareAttribute *attrib);
|
|
109
|
|
110
|
|
111 struct mwAwareListHandler {
|
|
112 /** handle aware updates */
|
|
113 mwAwareSnapshotHandler on_aware;
|
|
114
|
|
115 /** handle attribute updates */
|
|
116 mwAwareIdAttributeHandler on_attrib;
|
|
117
|
|
118 /** optional. Called from mwAwareList_free */
|
|
119 void (*clear)(struct mwAwareList *list);
|
|
120 };
|
|
121
|
|
122
|
|
123 struct mwServiceAware *
|
|
124 mwServiceAware_new(struct mwSession *session,
|
|
125 struct mwAwareHandler *handler);
|
|
126
|
|
127
|
|
128 /** Set an attribute value for this session */
|
|
129 int mwServiceAware_setAttribute(struct mwServiceAware *srvc,
|
|
130 guint32 key, struct mwOpaque *opaque);
|
|
131
|
|
132
|
|
133 int mwServiceAware_setAttributeBoolean(struct mwServiceAware *srvc,
|
|
134 guint32 key, gboolean val);
|
|
135
|
|
136
|
|
137 int mwServiceAware_setAttributeInteger(struct mwServiceAware *srvc,
|
|
138 guint32 key, guint32 val);
|
|
139
|
|
140
|
|
141 int mwServiceAware_setAttributeString(struct mwServiceAware *srvc,
|
|
142 guint32 key, const char *str);
|
|
143
|
|
144
|
|
145 /** Unset an attribute for this session */
|
|
146 int mwServiceAware_unsetAttribute(struct mwServiceAware *srvc,
|
|
147 guint32 key);
|
|
148
|
|
149
|
|
150 guint32 mwAwareAttribute_getKey(const struct mwAwareAttribute *attrib);
|
|
151
|
|
152
|
|
153 gboolean mwAwareAttribute_asBoolean(const struct mwAwareAttribute *attrib);
|
|
154
|
|
155
|
|
156 guint32 mwAwareAttribute_asInteger(const struct mwAwareAttribute *attrib);
|
|
157
|
|
158
|
|
159 /** Copy of attribute string, must be g_free'd. If the attribute's
|
|
160 content cannot be loaded as a string, returns NULL */
|
|
161 char *mwAwareAttribute_asString(const struct mwAwareAttribute *attrib);
|
|
162
|
|
163
|
|
164 /** Direct access to an attribute's underlying opaque */
|
|
165 const struct mwOpaque *
|
|
166 mwAwareAttribute_asOpaque(const struct mwAwareAttribute *attrib);
|
|
167
|
|
168
|
|
169 /** Allocate and initialize an aware list */
|
|
170 struct mwAwareList *
|
|
171 mwAwareList_new(struct mwServiceAware *srvc,
|
|
172 struct mwAwareListHandler *handler);
|
|
173
|
|
174
|
|
175 /** Clean and free an aware list */
|
|
176 void mwAwareList_free(struct mwAwareList *list);
|
|
177
|
|
178
|
|
179 struct mwAwareListHandler *mwAwareList_getHandler(struct mwAwareList *list);
|
|
180
|
|
181
|
|
182 /** Add a collection of user IDs to an aware list.
|
|
183 @param list mwAwareList to add user ID to
|
|
184 @param id_list mwAwareIdBlock list of user IDs to add
|
|
185 @return 0 for success, non-zero to indicate an error.
|
|
186 */
|
|
187 int mwAwareList_addAware(struct mwAwareList *list, GList *id_list);
|
|
188
|
|
189
|
|
190 /** Remove a collection of user IDs from an aware list.
|
|
191 @param list mwAwareList to remove user ID from
|
|
192 @param id_list mwAwareIdBlock list of user IDs to remove
|
|
193 @return 0 for success, non-zero to indicate an error.
|
|
194 */
|
|
195 int mwAwareList_removeAware(struct mwAwareList *list, GList *id_list);
|
|
196
|
|
197
|
|
198 int mwAwareList_removeAllAware(struct mwAwareList *list);
|
|
199
|
|
200
|
|
201 /** watch an NULL terminated array of keys */
|
|
202 int mwAwareList_watchAttributeArray(struct mwAwareList *list,
|
|
203 guint32 *keys);
|
|
204
|
|
205
|
|
206 /** watch a NULL terminated list of keys */
|
|
207 int mwAwareList_watchAttributes(struct mwAwareList *list,
|
|
208 guint32 key, ...);
|
|
209
|
|
210
|
|
211 /** stop watching a NULL terminated array of keys */
|
|
212 int mwAwareList_unwatchAttributeArray(struct mwAwareList *list,
|
|
213 guint32 *keys);
|
|
214
|
|
215
|
|
216 /** stop watching a NULL terminated list of keys */
|
|
217 int mwAwareList_unwatchAttributes(struct mwAwareList *list,
|
|
218 guint32 key, ...);
|
|
219
|
|
220
|
|
221 /** remove all watched attributes */
|
|
222 int mwAwareList_unwatchAllAttributes(struct mwAwareList *list);
|
|
223
|
|
224
|
|
225 guint32 *mwAwareList_getWatchedAttributes(struct mwAwareList *list);
|
|
226
|
|
227
|
|
228 void mwAwareList_setClientData(struct mwAwareList *list,
|
|
229 gpointer data, GDestroyNotify cleanup);
|
|
230
|
|
231
|
|
232 void mwAwareList_removeClientData(struct mwAwareList *list);
|
|
233
|
|
234
|
|
235 gpointer mwAwareList_getClientData(struct mwAwareList *list);
|
|
236
|
|
237
|
|
238 /** trigger a got_aware event constructed from the passed user and
|
|
239 status information. Useful for adding false users and having the
|
|
240 getText function work for them */
|
|
241 void mwServiceAware_setStatus(struct mwServiceAware *srvc,
|
|
242 struct mwAwareIdBlock *user,
|
|
243 struct mwUserStatus *stat);
|
|
244
|
|
245
|
|
246 /** look up the status description for a user */
|
|
247 const char *mwServiceAware_getText(struct mwServiceAware *srvc,
|
|
248 struct mwAwareIdBlock *user);
|
|
249
|
|
250
|
|
251 /** look up the last known copy of an attribute for a user by the
|
|
252 attribute's key */
|
|
253 const struct mwAwareAttribute *
|
|
254 mwServiceAware_getAttribute(struct mwServiceAware *srvc,
|
|
255 struct mwAwareIdBlock *user,
|
|
256 guint32 key);
|
|
257
|
|
258
|
|
259 #endif
|
|
260
|
|
261
|