meanwhile 1.1.0
mw_srvc_store.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_SRVC_STORE_H
22#define _MW_SRVC_STORE_H
23
24
25#include <glib.h>
26#include "mw_common.h"
27
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33
35#define mwService_STORAGE 0x00000018
36
37
42struct mwServiceStorage;
43
44
49struct mwStorageUnit;
50
51
53#define LOTUS_RESERVED_LIMIT 0x186a0
54
55
57#define KEY_IS_LOTUS_RESERVED(key) \
58 (((guint32) key) <= (LOTUS_RESERVED_LIMIT))
59
60
65
67 mwStore_AWARE_LIST = 0x00000000,
68
70 mwStore_INVITE_CHAT = 0x00000006,
71
74
77
80
83};
84
85
92typedef void (*mwStorageCallback)
93 (struct mwServiceStorage *srvc,
94 guint32 result, struct mwStorageUnit *item,
95 gpointer data);
96
97
101
102
104struct mwStorageUnit *mwStorageUnit_new(guint32 key);
105
106
108struct mwStorageUnit *mwStorageUnit_newOpaque(guint32 key,
109 struct mwOpaque *data);
110
111
114struct mwStorageUnit *mwStorageUnit_newBoolean(guint32 key,
115 gboolean val);
116
117
118struct mwStorageUnit *mwStorageUnit_newInteger(guint32 key,
119 guint32 val);
120
121
124struct mwStorageUnit *mwStorageUnit_newString(guint32 key,
125 const char *str);
126
127
129guint32 mwStorageUnit_getKey(struct mwStorageUnit *);
130
131
135gboolean mwStorageUnit_asBoolean(struct mwStorageUnit *, gboolean val);
136
137
141guint32 mwStorageUnit_asInteger(struct mwStorageUnit *, guint32 val);
142
143
148char *mwStorageUnit_asString(struct mwStorageUnit *);
149
150
152struct mwOpaque *mwStorageUnit_asOpaque(struct mwStorageUnit *);
153
154
156void mwStorageUnit_free(struct mwStorageUnit *);
157
158
170 struct mwStorageUnit *item,
172 gpointer data, GDestroyNotify data_free);
173
174
186 struct mwStorageUnit *item,
188 gpointer data, GDestroyNotify data_free);
189
190
191#ifdef __cplusplus
192}
193#endif
194
195
196#endif /* _MW_SRVC_STORE_H */
Common data types and functions for handling those types.
struct mwServiceStorage * mwServiceStorage_new(struct mwSession *)
Allocates and initializes a storage service instance for use on the passed session.
struct mwStorageUnit * mwStorageUnit_newInteger(guint32 key, guint32 val)
guint32 mwStorageUnit_asInteger(struct mwStorageUnit *, guint32 val)
attempts to obtain a guint32 value from a storage unit.
guint32 mwStorageUnit_getKey(struct mwStorageUnit *)
get the key for the given storage unit
void mwServiceStorage_save(struct mwServiceStorage *srvc, struct mwStorageUnit *item, mwStorageCallback cb, gpointer data, GDestroyNotify data_free)
Initiates a store call to the storage service.
struct mwStorageUnit * mwStorageUnit_newString(guint32 key, const char *str)
creates a storage unit with the passed key, and an encapsulated string value.
struct mwStorageUnit * mwStorageUnit_newOpaque(guint32 key, struct mwOpaque *data)
creates a storage unit with the passed key, and a copy of data.
void(* mwStorageCallback)(struct mwServiceStorage *srvc, guint32 result, struct mwStorageUnit *item, gpointer data)
Appropriate function type for load and store callbacks.
Definition: mw_srvc_store.h:93
void mwServiceStorage_load(struct mwServiceStorage *srvc, struct mwStorageUnit *item, mwStorageCallback cb, gpointer data, GDestroyNotify data_free)
Initiates a load call to the storage service.
struct mwStorageUnit * mwStorageUnit_newBoolean(guint32 key, gboolean val)
creates a storage unit with the passed key, and an encapsulated boolean value
mwStorageKey
Some common keys storage keys.
Definition: mw_srvc_store.h:64
@ mwStore_BUSY_MESSAGES
Last five Busy (DND) messages, separated by semicolon.
Definition: mw_srvc_store.h:79
@ mwStore_INVITE_CHAT
Default text for chat invitations.
Definition: mw_srvc_store.h:70
@ mwStore_AWAY_MESSAGES
Last five Away messages, separated by semicolon.
Definition: mw_srvc_store.h:76
@ mwStore_AWARE_LIST
The buddy list, in the Sametime .dat file format.
Definition: mw_srvc_store.h:67
@ mwStore_ACTIVE_MESSAGES
Last five Active messages, separated by semicolon.
Definition: mw_srvc_store.h:82
@ mwStore_INVITE_MEETING
Default text for meeting invitations.
Definition: mw_srvc_store.h:73
char * mwStorageUnit_asString(struct mwStorageUnit *)
attempts to obtain a string value from a storage unit.
struct mwOpaque * mwStorageUnit_asOpaque(struct mwStorageUnit *)
direct access to the opaque data backing the storage unit
void mwStorageUnit_free(struct mwStorageUnit *)
clears and frees a storage unit
gboolean mwStorageUnit_asBoolean(struct mwStorageUnit *, gboolean val)
attempts to obtain a boolean value from a storage unit.
struct mwStorageUnit * mwStorageUnit_new(guint32 key)
create an empty storage unit
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
Represents a Sametime client session.