<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>meanwhile: mw_srvc_conf.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>mw_srvc_conf.h</h1><a href="mw__srvc__conf_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> Meanwhile - Unofficial Lotus Sametime Community Client Library</span>
<a name="l00004"></a>00004 <span class="comment"> Copyright (C) 2004 Christopher (siege) O'Brien</span>
<a name="l00005"></a>00005 <span class="comment"> </span>
<a name="l00006"></a>00006 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> </span>
<a name="l00011"></a>00011 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00014"></a>00014 <span class="comment"> Library General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> </span>
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU Library General Public</span>
<a name="l00017"></a>00017 <span class="comment"> License along with this library; if not, write to the Free</span>
<a name="l00018"></a>00018 <span class="comment"> Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00019"></a>00019 <span class="comment">*/</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef _MW_SRVC_CONF_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define _MW_SRVC_CONF_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include <glib/glist.h></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="mw__common_8h.html" title="Common data types and functions for handling those types.">mw_common.h</a>"</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00031"></a>00031 <span class="preprocessor">#endif</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033
<a name="l00035"></a><a class="code" href="mw__srvc__conf_8h.html#ad8f48542fd7fe5ffaff8f7f90e5761ba">00035</a> <span class="preprocessor">#define mwService_CONFERENCE 0x80000010</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span>
<a name="l00037"></a>00037
<a name="l00038"></a><a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769b">00038</a> <span class="keyword">enum</span> <a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769b">mwConferenceState</a> {
<a name="l00039"></a><a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba37db6af7a838a678443f29c419ec8bb2">00039</a> <a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba37db6af7a838a678443f29c419ec8bb2" title="new outgoing conference">mwConference_NEW</a>,
<a name="l00040"></a><a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba9701f7eb558ea283c38b8e4b2620f796">00040</a> <a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba9701f7eb558ea283c38b8e4b2620f796" title="outgoing conference pending creation">mwConference_PENDING</a>,
<a name="l00041"></a><a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba632f57891610ad036e1a8509bb46f06a">00041</a> <a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba632f57891610ad036e1a8509bb46f06a" title="invited to incoming conference">mwConference_INVITED</a>,
<a name="l00042"></a><a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba9dd06899a08e0615677b596911802767">00042</a> <a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba9dd06899a08e0615677b596911802767" title="conference open and active">mwConference_OPEN</a>,
<a name="l00043"></a><a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba065d75ce547194ba92fc0099b23b747d">00043</a> <a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba065d75ce547194ba92fc0099b23b747d" title="conference is closing">mwConference_CLOSING</a>,
<a name="l00044"></a><a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba136383c28f5cd5b8f6be65a918a3a33e">00044</a> <a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba136383c28f5cd5b8f6be65a918a3a33e" title="conference is closing due to error">mwConference_ERROR</a>,
<a name="l00045"></a><a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba3951a7b58e6e8bedf99f5daf0481f70e">00045</a> <a class="code" href="mw__srvc__conf_8h.html#a38a99c3a1b0935e1036af3d2f440769ba3951a7b58e6e8bedf99f5daf0481f70e" title="unable to determine conference state">mwConference_UNKNOWN</a>,
<a name="l00046"></a>00046 };
<a name="l00047"></a>00047
<a name="l00048"></a>00048
<a name="l00051"></a><a class="code" href="structmwConference.html">00051</a> <span class="keyword">struct </span><a class="code" href="structmwServiceConference.html" title="Instance of the multi-user conference service.">mwServiceConference</a>;
<a name="l00052"></a>00052
<a name="l00053"></a>00053
<a name="l00056"></a>00056 <span class="keyword">struct </span><a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a>;
<a name="l00057"></a>00057
<a name="l00058"></a>00058
<a name="l00061"></a><a class="code" href="structmwConferenceHandler.html">00061</a> <span class="keyword">struct </span><a class="code" href="structmwConferenceHandler.html" title="Handler structure used to provide callbacks for an instance of the conferencing service...">mwConferenceHandler</a> {
<a name="l00062"></a>00062
<a name="l00071"></a>00071 void (*<a class="code" href="structmwConferenceHandler.html#a91714a43285481c1a5d69c6555c3e63b" title="triggered when we receive a conference invitation.">on_invited</a>)(<span class="keyword">struct </span><a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf,
<a name="l00072"></a>00072 <span class="keyword">struct </span><a class="code" href="structmwLoginInfo.html">mwLoginInfo</a> *inviter, <span class="keyword">const</span> <span class="keywordtype">char</span> *invite);
<a name="l00073"></a>00073
<a name="l00080"></a>00080 void (*<a class="code" href="structmwConferenceHandler.html#aa2cfcf5618553566171d563aa28143b3" title="triggered when we enter the conference.">conf_opened</a>)(<span class="keyword">struct </span><a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf, GList *members);
<a name="l00081"></a>00081
<a name="l00084"></a>00084 void (*<a class="code" href="structmwConferenceHandler.html#adaf2d26388570cded44a62071755861c" title="triggered when a conference is closed.">conf_closed</a>)(<span class="keyword">struct </span><a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *, guint32 reason);
<a name="l00085"></a>00085
<a name="l00087"></a>00087 void (*<a class="code" href="structmwConferenceHandler.html#ac100418474bbc4436df60eea3b27c61e" title="triggered when someone joins the conference">on_peer_joined</a>)(<span class="keyword">struct </span><a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *, <span class="keyword">struct </span><a class="code" href="structmwLoginInfo.html">mwLoginInfo</a> *);
<a name="l00088"></a>00088
<a name="l00090"></a>00090 void (*<a class="code" href="structmwConferenceHandler.html#aa6cc8db29ea47b86ab122d496105c637" title="triggered when someone leaves the conference">on_peer_parted</a>)(<span class="keyword">struct </span><a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *, <span class="keyword">struct </span><a class="code" href="structmwLoginInfo.html">mwLoginInfo</a> *);
<a name="l00091"></a>00091
<a name="l00093"></a>00093 void (*<a class="code" href="structmwConferenceHandler.html#a3dec196446b69bbb37461d4ae977bee3" title="triggered when someone says something">on_text</a>)(<span class="keyword">struct </span><a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf,
<a name="l00094"></a>00094 <span class="keyword">struct </span><a class="code" href="structmwLoginInfo.html">mwLoginInfo</a> *who, <span class="keyword">const</span> <span class="keywordtype">char</span> *what);
<a name="l00095"></a>00095
<a name="l00097"></a>00097 void (*<a class="code" href="structmwConferenceHandler.html#aa6f01c365dfb40da0866f96301ac625b" title="typing notification">on_typing</a>)(<span class="keyword">struct </span><a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf,
<a name="l00098"></a>00098 <span class="keyword">struct </span><a class="code" href="structmwLoginInfo.html">mwLoginInfo</a> *who, gboolean typing);
<a name="l00099"></a>00099
<a name="l00101"></a>00101 void (*<a class="code" href="structmwConferenceHandler.html#aaeabf8dc22690c323864ac4cfd5a6871" title="optional.">clear</a>)(<span class="keyword">struct </span><a class="code" href="structmwServiceConference.html" title="Instance of the multi-user conference service.">mwServiceConference</a> *srvc);
<a name="l00102"></a>00102 };
<a name="l00103"></a>00103
<a name="l00104"></a>00104
<a name="l00109"></a>00109 <span class="keyword">struct </span><a class="code" href="structmwServiceConference.html" title="Instance of the multi-user conference service.">mwServiceConference</a> *
<a name="l00110"></a>00110 <a class="code" href="mw__srvc__conf_8h.html#a67d53a162d0b826956de5406e5352680" title="Allocate a new conferencing service, attaching the given handler.">mwServiceConference_new</a>(<span class="keyword">struct</span> <a class="code" href="structmwSession.html" title="Represents a Sametime client session.">mwSession</a> *sess,
<a name="l00111"></a>00111 <span class="keyword">struct</span> <a class="code" href="structmwConferenceHandler.html" title="Handler structure used to provide callbacks for an instance of the conferencing service...">mwConferenceHandler</a> *handler);
<a name="l00112"></a>00112
<a name="l00113"></a>00113
<a name="l00115"></a>00115 <span class="keyword">struct </span><a class="code" href="structmwConferenceHandler.html" title="Handler structure used to provide callbacks for an instance of the conferencing service...">mwConferenceHandler</a> *
<a name="l00116"></a>00116 <a class="code" href="mw__srvc__conf_8h.html#ab23596a80b89b8700d598f499f98cf8a">mwServiceConference_getHandler</a>(<span class="keyword">struct</span> <a class="code" href="structmwServiceConference.html" title="Instance of the multi-user conference service.">mwServiceConference</a> *srvc);
<a name="l00117"></a>00117
<a name="l00118"></a>00118
<a name="l00121"></a>00121 GList *<a class="code" href="mw__srvc__conf_8h.html#a82ad4285b9310ba22ea8552b2f477a0d" title="a mwConference list of the conferences in this service.">mwServiceConference_getConferences</a>(<span class="keyword">struct</span> <a class="code" href="structmwServiceConference.html" title="Instance of the multi-user conference service.">mwServiceConference</a> *srvc);
<a name="l00122"></a>00122
<a name="l00123"></a>00123
<a name="l00126"></a>00126 <span class="keyword">struct </span><a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *<a class="code" href="mw__srvc__conf_8h.html#acdf190d49eb2dcb606d3f7370bb7c7e3" title="Allocate a new conference, in state NEW with the given title.">mwConference_new</a>(<span class="keyword">struct</span> <a class="code" href="structmwServiceConference.html" title="Instance of the multi-user conference service.">mwServiceConference</a> *srvc,
<a name="l00127"></a>00127 <span class="keyword">const</span> <span class="keywordtype">char</span> *title);
<a name="l00128"></a>00128
<a name="l00129"></a>00129
<a name="l00131"></a>00131 <span class="keyword">struct </span><a class="code" href="structmwServiceConference.html" title="Instance of the multi-user conference service.">mwServiceConference</a> *<a class="code" href="mw__srvc__conf_8h.html#a66d71802e4ad77bbe8d8a37c783d8073">mwConference_getService</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf);
<a name="l00132"></a>00132
<a name="l00133"></a>00133
<a name="l00135"></a>00135 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="mw__srvc__conf_8h.html#a7bf4f4c29db684a4cd2b7d6e4f135db7">mwConference_getName</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf);
<a name="l00136"></a>00136
<a name="l00137"></a>00137
<a name="l00139"></a>00139 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="mw__srvc__conf_8h.html#a455cdae2de31586fc42e078a9dfeb7f7">mwConference_getTitle</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf);
<a name="l00140"></a>00140
<a name="l00141"></a>00141
<a name="l00144"></a>00144 GList *<a class="code" href="mw__srvc__conf_8h.html#a46d04258c983e97dec851ae346a7a002" title="a mwIdBlock list of the members of the conference.">mwConference_getMembers</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf);
<a name="l00145"></a>00145
<a name="l00146"></a>00146
<a name="l00150"></a>00150 <span class="keywordtype">int</span> <a class="code" href="mw__srvc__conf_8h.html#a0fc8e4a2b7209497b6900aa18ac57d6b" title="Initiate a conference.">mwConference_open</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf);
<a name="l00151"></a>00151
<a name="l00152"></a>00152
<a name="l00157"></a>00157 <span class="keywordtype">int</span> <a class="code" href="mw__srvc__conf_8h.html#a36474f0e5e6309a8306d5085c46337af" title="Leave and close an existing conference, or reject an invitation.">mwConference_destroy</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf,
<a name="l00158"></a>00158 guint32 reason, <span class="keyword">const</span> <span class="keywordtype">char</span> *text);
<a name="l00159"></a>00159
<a name="l00160"></a>00160
<a name="l00161"></a><a class="code" href="mw__srvc__conf_8h.html#a6bb5b583c0d0ddbfbda7e5c3c19479a0">00161</a> <span class="preprocessor">#define mwConference_reject(c,r,t) \</span>
<a name="l00162"></a>00162 <span class="preprocessor"> mwConference_destroy((c),(r),(t))</span>
<a name="l00163"></a>00163 <span class="preprocessor"></span>
<a name="l00164"></a>00164
<a name="l00167"></a>00167 <span class="keywordtype">int</span> <a class="code" href="mw__srvc__conf_8h.html#a1f264a8a152d9b37e07da49fc2c59dfb" title="accept a conference invitation.">mwConference_accept</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf);
<a name="l00168"></a>00168
<a name="l00169"></a>00169
<a name="l00175"></a>00175 <span class="keywordtype">int</span> <a class="code" href="mw__srvc__conf_8h.html#a25be74a7340874274f96fe9b46287805" title="invite another user to an ACTIVE conference">mwConference_invite</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf,
<a name="l00176"></a>00176 <span class="keyword">struct</span> <a class="code" href="structmwIdBlock.html">mwIdBlock</a> *who, <span class="keyword">const</span> <span class="keywordtype">char</span> *text);
<a name="l00177"></a>00177
<a name="l00178"></a>00178
<a name="l00180"></a>00180 <span class="keywordtype">int</span> <a class="code" href="mw__srvc__conf_8h.html#a5c3b16cc84d63dab6699a89a1d17c5c9" title="send a text message over an open conference">mwConference_sendText</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf, <span class="keyword">const</span> <span class="keywordtype">char</span> *text);
<a name="l00181"></a>00181
<a name="l00182"></a>00182
<a name="l00184"></a>00184 <span class="keywordtype">int</span> <a class="code" href="mw__srvc__conf_8h.html#a8ea1c62150c4fc32a8e55c9c07731062" title="send typing notification over an open conference">mwConference_sendTyping</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf, gboolean typing);
<a name="l00185"></a>00185
<a name="l00186"></a>00186
<a name="l00190"></a>00190 <span class="keywordtype">void</span> <a class="code" href="mw__srvc__conf_8h.html#a8fb8832aedee72fd8047e4fbef752eb7" title="associate arbitrary client data and an optional cleanup function with a conference...">mwConference_setClientData</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf,
<a name="l00191"></a>00191 gpointer data, GDestroyNotify <a class="code" href="structmwService.html#a9b86cc0545150a4fde3ab3060e803e58" title="The service&#39;s cleanup handler.">clear</a>);
<a name="l00192"></a>00192
<a name="l00193"></a>00193
<a name="l00195"></a>00195 gpointer <a class="code" href="mw__srvc__conf_8h.html#a3e0cc8dd7b1198884523ea8b7a226eed" title="reference associated client data">mwConference_getClientData</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf);
<a name="l00196"></a>00196
<a name="l00197"></a>00197
<a name="l00200"></a>00200 <span class="keywordtype">void</span> <a class="code" href="mw__srvc__conf_8h.html#afe7e528a049a5603a11d28e96c18ec61" title="remove associated client data if any, and call the cleanup function on the data as...">mwConference_removeClientData</a>(<span class="keyword">struct</span> <a class="code" href="structmwConference.html" title="A multi-user chat.">mwConference</a> *conf);
<a name="l00201"></a>00201
<a name="l00202"></a>00202
<a name="l00203"></a>00203 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00204"></a>00204 <span class="preprocessor"></span>}
<a name="l00205"></a>00205 <span class="preprocessor">#endif</span>
<a name="l00206"></a>00206 <span class="preprocessor"></span>
<a name="l00207"></a>00207
<a name="l00208"></a>00208 <span class="preprocessor">#endif </span><span class="comment">/* _MW_SRVC_CONF_H */</span>
<a name="l00209"></a>00209
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>
