meanwhile 1.1.1
mw_srvc_dir.h
Go to the documentation of this file.
1/*
2 Meanwhile - Unofficial Lotus Sametime Community Client Library
3 Copyright (C) 2004 Christopher (siege) O'Brien
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with this library; if not, write to the Free
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18*/
19
20#ifndef _MW_SRVC_DIR_H
21#define _MW_SRVC_DIR_H
22
23
24#include <glib.h>
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30
31struct mwSession;
32
33
34#define SERVICE_DIRECTORY 0x0000001a
35
36
41
42
47struct mwAddressBook;
48
49
53struct mwDirectory;
54
55
62};
63
64
66#define DIR_SEARCH_ERROR 0x00000000
67
68
69#define MW_DIRECTORY_IS_STATE(dir, state) \
70 (mwDirectory_getState(dir) == (state))
71
72#define MW_DIRECTORY_IS_NEW(dir) \
73 MW_DIRECTORY_IS_STATE((dir), mwDirectory_NEW)
74
75#define MW_DIRECTORY_IS_PENDING(dir) \
76 MW_DIRECTORY_IS_STATE((dir), mwDirectory_PENDING)
77
78#define MW_DIRECTORY_IS_OPEN(dir) \
79 MW_DIRECTORY_IS_STATE((dir), mwDirectory_OPEN)
80
81
85};
86
87
89 guint16 type;
90 char *id;
91 char *long_name;
92 char *short_name;
93 guint16 foo;
94};
95
96
98typedef void (*mwSearchHandler)
99 (struct mwDirectory *dir,
100 guint32 code, guint32 offset, GList *members);
101
102
105
109 void (*on_book_list)(struct mwServiceDirectory *srvc, GList *books);
110
112 void (*dir_opened)(struct mwDirectory *dir);
113
115 void (*dir_closed)(struct mwDirectory *dir, guint32 reason);
116
118 void (*clear)(struct mwServiceDirectory *srvc);
119};
120
121
123struct mwServiceDirectory *
125 struct mwDirectoryHandler *handler);
126
127
129struct mwDirectoryHandler *
131
132
135
136
140
141
144
145
149
150
152const char *mwAddressBook_getName(struct mwAddressBook *book);
153
154
157
158
160
161
165 gpointer data, GDestroyNotify clear);
166
167
170
171
174
175
178
179
182
183
186
187
190
191
194
195
197int mwDirectory_search(struct mwDirectory *dir, const char *query);
198
199
203
204
205#ifdef __cplusplus
206}
207#endif
208
209
210#endif /* _MW_SRVC_DIR_H */
void(* mwSearchHandler)(struct mwDirectory *dir, guint32 code, guint32 offset, GList *members)
Appropriate function signature for handling directory search results.
Definition: mw_srvc_dir.h:99
GList * mwServiceDirectory_getAddressBooks(struct mwServiceDirectory *srvc)
most recent list of address books available in service
mwDirectoryMemberType
Definition: mw_srvc_dir.h:82
@ mwDirectoryMember_GROUP
Definition: mw_srvc_dir.h:84
@ mwDirectoryMember_USER
Definition: mw_srvc_dir.h:83
int mwServiceDirectory_refreshAddressBooks(struct mwServiceDirectory *srvc)
submit a request to obtain an updated list of address books from service
void mwDirectory_removeClientData(struct mwDirectory *dir)
remove and cleanup user data
struct mwServiceDirectory * mwDirectory_getService(struct mwDirectory *dir)
reference owning service
struct mwDirectoryHandler * mwServiceDirectory_getHandler(struct mwServiceDirectory *srvc)
the handler associated with the service at its creation
const char * mwAddressBook_getName(struct mwAddressBook *book)
the name of the address book
mwDirectoryState
Definition: mw_srvc_dir.h:56
@ mwDirectory_ERROR
error opening or using directory
Definition: mw_srvc_dir.h:60
@ mwDirectory_UNKNOWN
error determining directory state
Definition: mw_srvc_dir.h:61
@ mwDirectory_OPEN
directory is open
Definition: mw_srvc_dir.h:59
@ mwDirectory_NEW
directory is created, but not open
Definition: mw_srvc_dir.h:57
@ mwDirectory_PENDING
directory has in the process of opening
Definition: mw_srvc_dir.h:58
gpointer mwDirectory_getClientData(struct mwDirectory *dir)
reference associated client data
int mwDirectory_open(struct mwDirectory *dir, mwSearchHandler cb)
initialize a directory.
int mwDirectory_search(struct mwDirectory *dir, const char *query)
initiate a search on an open directory
GList * mwServiceDirectory_getDirectories(struct mwServiceDirectory *srvc)
list of directories in the service
enum mwDirectoryState mwDirectory_getState(struct mwDirectory *dir)
GList * mwAddressBook_getDirectories(struct mwAddressBook *book)
list of directories associated with address book.
void mwDirectory_setClientData(struct mwDirectory *dir, gpointer data, GDestroyNotify clear)
set client data.
struct mwAddressBook * mwDirectory_getAddressBook(struct mwDirectory *dir)
reference owning address book
struct mwDirectory * mwDirectory_new(struct mwAddressBook *book)
allocate a new directory based off the given address book
int mwDirectory_next(struct mwDirectory *dir)
continue a search into its next results
int mwDirectory_destroy(struct mwDirectory *dir)
close and free the directory, and unassociate it with its owning address book and service
struct mwServiceDirectory * mwServiceDirectory_new(struct mwSession *session, struct mwDirectoryHandler *handler)
Allocate a new directory service instance for use with session.
int mwDirectory_previous(struct mwDirectory *dir)
continue a search into its previous results
server-side collection of users and groups.
handles asynchronous events for a directory service instance
Definition: mw_srvc_dir.h:104
void(* on_book_list)(struct mwServiceDirectory *srvc, GList *books)
handle receipt of the address book list from the service.
Definition: mw_srvc_dir.h:109
void(* clear)(struct mwServiceDirectory *srvc)
optional.
Definition: mw_srvc_dir.h:118
void(* dir_closed)(struct mwDirectory *dir, guint32 reason)
triggered when a directory has been closed
Definition: mw_srvc_dir.h:115
void(* dir_opened)(struct mwDirectory *dir)
triggered when a directory has been successfully opened
Definition: mw_srvc_dir.h:112
Definition: mw_srvc_dir.h:88
guint16 foo
unknown
Definition: mw_srvc_dir.h:93
char * id
proper ID for member
Definition: mw_srvc_dir.h:90
char * short_name
short name of member
Definition: mw_srvc_dir.h:92
char * long_name
full name of member (USER type only)
Definition: mw_srvc_dir.h:91
guint16 type
Definition: mw_srvc_dir.h:89
searchable directory, based off of an address book
the directory service.
struct mwSession * session
session this service is attached to.
Definition: mw_service.h:139
mwService_funcClear clear
The service's cleanup handler.
Definition: mw_service.h:195
Represents a Sametime client session.