meanwhile 1.1.1
mw_srvc_conf.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_CONF_H
22#define _MW_SRVC_CONF_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_CONFERENCE 0x80000010
36
37
46};
47
48
52
53
56struct mwConference;
57
58
62
71 void (*on_invited)(struct mwConference *conf,
72 struct mwLoginInfo *inviter, const char *invite);
73
80 void (*conf_opened)(struct mwConference *conf, GList *members);
81
84 void (*conf_closed)(struct mwConference *, guint32 reason);
85
87 void (*on_peer_joined)(struct mwConference *, struct mwLoginInfo *);
88
90 void (*on_peer_parted)(struct mwConference *, struct mwLoginInfo *);
91
93 void (*on_text)(struct mwConference *conf,
94 struct mwLoginInfo *who, const char *what);
95
97 void (*on_typing)(struct mwConference *conf,
98 struct mwLoginInfo *who, gboolean typing);
99
101 void (*clear)(struct mwServiceConference *srvc);
102};
103
104
109struct mwServiceConference *
111 struct mwConferenceHandler *handler);
112
113
115struct mwConferenceHandler *
117
118
122
123
127 const char *title);
128
129
132
133
135const char *mwConference_getName(struct mwConference *conf);
136
137
139const char *mwConference_getTitle(struct mwConference *conf);
140
141
145
146
151
152
158 guint32 reason, const char *text);
159
160
161#define mwConference_reject(c,r,t) \
162 mwConference_destroy((c),(r),(t))
163
164
168
169
176 struct mwIdBlock *who, const char *text);
177
178
180int mwConference_sendText(struct mwConference *conf, const char *text);
181
182
184int mwConference_sendTyping(struct mwConference *conf, gboolean typing);
185
186
191 gpointer data, GDestroyNotify clear);
192
193
196
197
201
202
203#ifdef __cplusplus
204}
205#endif
206
207
208#endif /* _MW_SRVC_CONF_H */
209
Common data types and functions for handling those types.
int mwConference_open(struct mwConference *conf)
Initiate a conference.
struct mwServiceConference * mwConference_getService(struct mwConference *conf)
GList * mwServiceConference_getConferences(struct mwServiceConference *srvc)
a mwConference list of the conferences in this service.
int mwConference_accept(struct mwConference *conf)
accept a conference invitation.
int mwConference_invite(struct mwConference *conf, struct mwIdBlock *who, const char *text)
invite another user to an ACTIVE conference
struct mwConferenceHandler * mwServiceConference_getHandler(struct mwServiceConference *srvc)
int mwConference_destroy(struct mwConference *conf, guint32 reason, const char *text)
Leave and close an existing conference, or reject an invitation.
mwConferenceState
Definition: mw_srvc_conf.h:38
@ mwConference_CLOSING
conference is closing
Definition: mw_srvc_conf.h:43
@ mwConference_ERROR
conference is closing due to error
Definition: mw_srvc_conf.h:44
@ mwConference_NEW
new outgoing conference
Definition: mw_srvc_conf.h:39
@ mwConference_UNKNOWN
unable to determine conference state
Definition: mw_srvc_conf.h:45
@ mwConference_INVITED
invited to incoming conference
Definition: mw_srvc_conf.h:41
@ mwConference_PENDING
outgoing conference pending creation
Definition: mw_srvc_conf.h:40
@ mwConference_OPEN
conference open and active
Definition: mw_srvc_conf.h:42
gpointer mwConference_getClientData(struct mwConference *conf)
reference associated client data
struct mwServiceConference * mwServiceConference_new(struct mwSession *sess, struct mwConferenceHandler *handler)
Allocate a new conferencing service, attaching the given handler.
int mwConference_sendText(struct mwConference *conf, const char *text)
send a text message over an open conference
const char * mwConference_getName(struct mwConference *conf)
GList * mwConference_getMembers(struct mwConference *conf)
a mwIdBlock list of the members of the conference.
const char * mwConference_getTitle(struct mwConference *conf)
struct mwConference * mwConference_new(struct mwServiceConference *srvc, const char *title)
Allocate a new conference, in state NEW with the given title.
int mwConference_sendTyping(struct mwConference *conf, gboolean typing)
send typing notification over an open conference
void mwConference_setClientData(struct mwConference *conf, gpointer data, GDestroyNotify clear)
associate arbitrary client data and an optional cleanup function with a conference.
void mwConference_removeClientData(struct mwConference *conf)
remove associated client data if any, and call the cleanup function on the data as necessary
Handler structure used to provide callbacks for an instance of the conferencing service.
Definition: mw_srvc_conf.h:61
void(* on_text)(struct mwConference *conf, struct mwLoginInfo *who, const char *what)
triggered when someone says something
Definition: mw_srvc_conf.h:93
void(* on_peer_parted)(struct mwConference *, struct mwLoginInfo *)
triggered when someone leaves the conference
Definition: mw_srvc_conf.h:90
void(* conf_opened)(struct mwConference *conf, GList *members)
triggered when we enter the conference.
Definition: mw_srvc_conf.h:80
void(* on_peer_joined)(struct mwConference *, struct mwLoginInfo *)
triggered when someone joins the conference
Definition: mw_srvc_conf.h:87
void(* on_typing)(struct mwConference *conf, struct mwLoginInfo *who, gboolean typing)
typing notification
Definition: mw_srvc_conf.h:97
void(* clear)(struct mwServiceConference *srvc)
optional.
Definition: mw_srvc_conf.h:101
void(* on_invited)(struct mwConference *conf, struct mwLoginInfo *inviter, const char *invite)
triggered when we receive a conference invitation.
Definition: mw_srvc_conf.h:71
void(* conf_closed)(struct mwConference *, guint32 reason)
triggered when a conference is closed.
Definition: mw_srvc_conf.h:84
A multi-user chat.
Definition: mw_srvc_conf.h:51
Definition: mw_common.h:178
Definition: mw_common.h:123
Instance of the multi-user conference service.
mwService_funcClear clear
The service's cleanup handler.
Definition: mw_service.h:195
Represents a Sametime client session.