Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > d4a6745d7fbd92dfb64dce5e91e08f80 > files > 103

lib64meanwhile1-doc-1.0.2-1mdv2008.1.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>meanwhile: mw_srvc_conf.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.4 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>mw_srvc_conf.h File Reference</h1>
<p>
<code>#include &lt;glib/glist.h&gt;</code><br>
<code>#include &quot;<a class="el" href="mw__common_8h-source.html">mw_common.h</a>&quot;</code><br>

<p>
<a href="mw__srvc__conf_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmwConferenceHandler.html">mwConferenceHandler</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handler structure used to provide callbacks for an instance of the conferencing service.  <a href="structmwConferenceHandler.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#6bb5b583c0d0ddbfbda7e5c3c19479a0">mwConference_reject</a>(c, r, t)&nbsp;&nbsp;&nbsp;mwConference_destroy((c),(r),(t))</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#d8f48542fd7fe5ffaff8f7f90e5761ba">mwService_CONFERENCE</a>&nbsp;&nbsp;&nbsp;0x80000010</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type identifier for the conference service.  <a href="#d8f48542fd7fe5ffaff8f7f90e5761ba"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#38a99c3a1b0935e1036af3d2f440769b">mwConferenceState</a> { <br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__conf_8h.html#38a99c3a1b0935e1036af3d2f440769b37db6af7a838a678443f29c419ec8bb2">mwConference_NEW</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__conf_8h.html#38a99c3a1b0935e1036af3d2f440769b9701f7eb558ea283c38b8e4b2620f796">mwConference_PENDING</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__conf_8h.html#38a99c3a1b0935e1036af3d2f440769b632f57891610ad036e1a8509bb46f06a">mwConference_INVITED</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__conf_8h.html#38a99c3a1b0935e1036af3d2f440769b9dd06899a08e0615677b596911802767">mwConference_OPEN</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__conf_8h.html#38a99c3a1b0935e1036af3d2f440769b065d75ce547194ba92fc0099b23b747d">mwConference_CLOSING</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__conf_8h.html#38a99c3a1b0935e1036af3d2f440769b136383c28f5cd5b8f6be65a918a3a33e">mwConference_ERROR</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="mw__srvc__conf_8h.html#38a99c3a1b0935e1036af3d2f440769b3951a7b58e6e8bedf99f5daf0481f70e">mwConference_UNKNOWN</a>
<br>
 }</td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#1f264a8a152d9b37e07da49fc2c59dfb">mwConference_accept</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">accept a conference invitation.  <a href="#1f264a8a152d9b37e07da49fc2c59dfb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#36474f0e5e6309a8306d5085c46337af">mwConference_destroy</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf, guint32 reason, const char *text)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Leave and close an existing conference, or reject an invitation.  <a href="#36474f0e5e6309a8306d5085c46337af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gpointer&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#3e0cc8dd7b1198884523ea8b7a226eed">mwConference_getClientData</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">reference associated client data  <a href="#3e0cc8dd7b1198884523ea8b7a226eed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GList *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#46d04258c983e97dec851ae346a7a002">mwConference_getMembers</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">a <a class="el" href="structmwIdBlock.html">mwIdBlock</a> list of the members of the conference.  <a href="#46d04258c983e97dec851ae346a7a002"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#7bf4f4c29db684a4cd2b7d6e4f135db7">mwConference_getName</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl class="return" compact><dt><b>Returns:</b></dt><dd>unique conference name </dd></dl>
 <a href="#7bf4f4c29db684a4cd2b7d6e4f135db7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwServiceConference.html">mwServiceConference</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#66d71802e4ad77bbe8d8a37c783d8073">mwConference_getService</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl class="return" compact><dt><b>Returns:</b></dt><dd>the owning service of a conference </dd></dl>
 <a href="#66d71802e4ad77bbe8d8a37c783d8073"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#455cdae2de31586fc42e078a9dfeb7f7">mwConference_getTitle</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl class="return" compact><dt><b>Returns:</b></dt><dd>conference title </dd></dl>
 <a href="#455cdae2de31586fc42e078a9dfeb7f7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#25be74a7340874274f96fe9b46287805">mwConference_invite</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf, struct <a class="el" href="structmwIdBlock.html">mwIdBlock</a> *who, const char *text)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">invite another user to an ACTIVE conference  <a href="#25be74a7340874274f96fe9b46287805"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#cdf190d49eb2dcb606d3f7370bb7c7e3">mwConference_new</a> (struct <a class="el" href="structmwServiceConference.html">mwServiceConference</a> *srvc, const char *title)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a new conference, in state NEW with the given title.  <a href="#cdf190d49eb2dcb606d3f7370bb7c7e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#0fc8e4a2b7209497b6900aa18ac57d6b">mwConference_open</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initiate a conference.  <a href="#0fc8e4a2b7209497b6900aa18ac57d6b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#fe7e528a049a5603a11d28e96c18ec61">mwConference_removeClientData</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">remove associated client data if any, and call the cleanup function on the data as necessary  <a href="#fe7e528a049a5603a11d28e96c18ec61"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#5c3b16cc84d63dab6699a89a1d17c5c9">mwConference_sendText</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf, const char *text)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">send a text message over an open conference  <a href="#5c3b16cc84d63dab6699a89a1d17c5c9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#8ea1c62150c4fc32a8e55c9c07731062">mwConference_sendTyping</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf, gboolean typing)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">send typing notification over an open conference  <a href="#8ea1c62150c4fc32a8e55c9c07731062"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#8fb8832aedee72fd8047e4fbef752eb7">mwConference_setClientData</a> (struct <a class="el" href="structmwConference.html">mwConference</a> *conf, gpointer data, GDestroyNotify <a class="el" href="structmwService.html#9b86cc0545150a4fde3ab3060e803e58">clear</a>)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">associate arbitrary client data and an optional cleanup function with a conference.  <a href="#8fb8832aedee72fd8047e4fbef752eb7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GList *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#82ad4285b9310ba22ea8552b2f477a0d">mwServiceConference_getConferences</a> (struct <a class="el" href="structmwServiceConference.html">mwServiceConference</a> *srvc)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">a <a class="el" href="structmwConference.html" title="A multi-user chat.">mwConference</a> list of the conferences in this service.  <a href="#82ad4285b9310ba22ea8552b2f477a0d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwConferenceHandler.html">mwConferenceHandler</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#b23596a80b89b8700d598f499f98cf8a">mwServiceConference_getHandler</a> (struct <a class="el" href="structmwServiceConference.html">mwServiceConference</a> *srvc)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl class="return" compact><dt><b>Returns:</b></dt><dd>the conference handler for the service </dd></dl>
 <a href="#b23596a80b89b8700d598f499f98cf8a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmwServiceConference.html">mwServiceConference</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mw__srvc__conf_8h.html#67d53a162d0b826956de5406e5352680">mwServiceConference_new</a> (struct <a class="el" href="structmwSession.html">mwSession</a> *sess, struct <a class="el" href="structmwConferenceHandler.html">mwConferenceHandler</a> *handler)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate a new conferencing service, attaching the given handler.  <a href="#67d53a162d0b826956de5406e5352680"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="6bb5b583c0d0ddbfbda7e5c3c19479a0"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_reject" ref="6bb5b583c0d0ddbfbda7e5c3c19479a0" args="(c, r, t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define mwConference_reject          </td>
          <td>(</td>
          <td class="paramtype">c,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">r,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">t&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%">&nbsp;&nbsp;&nbsp;mwConference_destroy((c),(r),(t))</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="d8f48542fd7fe5ffaff8f7f90e5761ba"></a><!-- doxytag: member="mw_srvc_conf.h::mwService_CONFERENCE" ref="d8f48542fd7fe5ffaff8f7f90e5761ba" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define mwService_CONFERENCE&nbsp;&nbsp;&nbsp;0x80000010          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Type identifier for the conference service. 
<p>

</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="38a99c3a1b0935e1036af3d2f440769b"></a><!-- doxytag: member="mw_srvc_conf.h::mwConferenceState" ref="38a99c3a1b0935e1036af3d2f440769b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="mw__srvc__conf_8h.html#38a99c3a1b0935e1036af3d2f440769b">mwConferenceState</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="38a99c3a1b0935e1036af3d2f440769b37db6af7a838a678443f29c419ec8bb2"></a><!-- doxytag: member="mwConference_NEW" ref="38a99c3a1b0935e1036af3d2f440769b37db6af7a838a678443f29c419ec8bb2" args="" -->mwConference_NEW</em>&nbsp;</td><td>
new outgoing conference </td></tr>
<tr><td valign="top"><em><a class="anchor" name="38a99c3a1b0935e1036af3d2f440769b9701f7eb558ea283c38b8e4b2620f796"></a><!-- doxytag: member="mwConference_PENDING" ref="38a99c3a1b0935e1036af3d2f440769b9701f7eb558ea283c38b8e4b2620f796" args="" -->mwConference_PENDING</em>&nbsp;</td><td>
outgoing conference pending creation </td></tr>
<tr><td valign="top"><em><a class="anchor" name="38a99c3a1b0935e1036af3d2f440769b632f57891610ad036e1a8509bb46f06a"></a><!-- doxytag: member="mwConference_INVITED" ref="38a99c3a1b0935e1036af3d2f440769b632f57891610ad036e1a8509bb46f06a" args="" -->mwConference_INVITED</em>&nbsp;</td><td>
invited to incoming conference </td></tr>
<tr><td valign="top"><em><a class="anchor" name="38a99c3a1b0935e1036af3d2f440769b9dd06899a08e0615677b596911802767"></a><!-- doxytag: member="mwConference_OPEN" ref="38a99c3a1b0935e1036af3d2f440769b9dd06899a08e0615677b596911802767" args="" -->mwConference_OPEN</em>&nbsp;</td><td>
conference open and active </td></tr>
<tr><td valign="top"><em><a class="anchor" name="38a99c3a1b0935e1036af3d2f440769b065d75ce547194ba92fc0099b23b747d"></a><!-- doxytag: member="mwConference_CLOSING" ref="38a99c3a1b0935e1036af3d2f440769b065d75ce547194ba92fc0099b23b747d" args="" -->mwConference_CLOSING</em>&nbsp;</td><td>
conference is closing </td></tr>
<tr><td valign="top"><em><a class="anchor" name="38a99c3a1b0935e1036af3d2f440769b136383c28f5cd5b8f6be65a918a3a33e"></a><!-- doxytag: member="mwConference_ERROR" ref="38a99c3a1b0935e1036af3d2f440769b136383c28f5cd5b8f6be65a918a3a33e" args="" -->mwConference_ERROR</em>&nbsp;</td><td>
conference is closing due to error </td></tr>
<tr><td valign="top"><em><a class="anchor" name="38a99c3a1b0935e1036af3d2f440769b3951a7b58e6e8bedf99f5daf0481f70e"></a><!-- doxytag: member="mwConference_UNKNOWN" ref="38a99c3a1b0935e1036af3d2f440769b3951a7b58e6e8bedf99f5daf0481f70e" args="" -->mwConference_UNKNOWN</em>&nbsp;</td><td>
unable to determine conference state </td></tr>
</table>
</dl>

</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="1f264a8a152d9b37e07da49fc2c59dfb"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_accept" ref="1f264a8a152d9b37e07da49fc2c59dfb" args="(struct mwConference *conf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mwConference_accept           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
accept a conference invitation. 
<p>
Conference must be in the state INVITED. 
</div>
</div><p>
<a class="anchor" name="36474f0e5e6309a8306d5085c46337af"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_destroy" ref="36474f0e5e6309a8306d5085c46337af" args="(struct mwConference *conf, guint32 reason, const char *text)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mwConference_destroy           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">guint32&nbsp;</td>
          <td class="paramname"> <em>reason</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>text</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Leave and close an existing conference, or reject an invitation. 
<p>
Triggers mwServiceConfHandler::conf_closed and free's the conference. 
</div>
</div><p>
<a class="anchor" name="3e0cc8dd7b1198884523ea8b7a226eed"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_getClientData" ref="3e0cc8dd7b1198884523ea8b7a226eed" args="(struct mwConference *conf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gpointer mwConference_getClientData           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
reference associated client data 
<p>

</div>
</div><p>
<a class="anchor" name="46d04258c983e97dec851ae346a7a002"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_getMembers" ref="46d04258c983e97dec851ae346a7a002" args="(struct mwConference *conf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GList* mwConference_getMembers           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
a <a class="el" href="structmwIdBlock.html">mwIdBlock</a> list of the members of the conference. 
<p>
The GList will need to be free'd after use 
</div>
</div><p>
<a class="anchor" name="7bf4f4c29db684a4cd2b7d6e4f135db7"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_getName" ref="7bf4f4c29db684a4cd2b7d6e4f135db7" args="(struct mwConference *conf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* mwConference_getName           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>unique conference name </dd></dl>

<p>

</div>
</div><p>
<a class="anchor" name="66d71802e4ad77bbe8d8a37c783d8073"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_getService" ref="66d71802e4ad77bbe8d8a37c783d8073" args="(struct mwConference *conf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwServiceConference.html">mwServiceConference</a>* mwConference_getService           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the owning service of a conference </dd></dl>

<p>

</div>
</div><p>
<a class="anchor" name="455cdae2de31586fc42e078a9dfeb7f7"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_getTitle" ref="455cdae2de31586fc42e078a9dfeb7f7" args="(struct mwConference *conf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* mwConference_getTitle           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>conference title </dd></dl>

<p>

</div>
</div><p>
<a class="anchor" name="25be74a7340874274f96fe9b46287805"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_invite" ref="25be74a7340874274f96fe9b46287805" args="(struct mwConference *conf, struct mwIdBlock *who, const char *text)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mwConference_invite           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structmwIdBlock.html">mwIdBlock</a> *&nbsp;</td>
          <td class="paramname"> <em>who</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>text</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
invite another user to an ACTIVE conference 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>conf</em>&nbsp;</td><td>conference </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>who</em>&nbsp;</td><td>user to invite </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>invitation message </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="cdf190d49eb2dcb606d3f7370bb7c7e3"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_new" ref="cdf190d49eb2dcb606d3f7370bb7c7e3" args="(struct mwServiceConference *srvc, const char *title)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwConference.html">mwConference</a>* mwConference_new           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwServiceConference.html">mwServiceConference</a> *&nbsp;</td>
          <td class="paramname"> <em>srvc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>title</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Allocate a new conference, in state NEW with the given title. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>mwConference_create </dd></dl>

</div>
</div><p>
<a class="anchor" name="0fc8e4a2b7209497b6900aa18ac57d6b"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_open" ref="0fc8e4a2b7209497b6900aa18ac57d6b" args="(struct mwConference *conf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mwConference_open           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initiate a conference. 
<p>
Conference must be in state NEW. If no name or title for the conference has been set, they will be generated. Conference will be placed into state PENDING. 
</div>
</div><p>
<a class="anchor" name="fe7e528a049a5603a11d28e96c18ec61"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_removeClientData" ref="fe7e528a049a5603a11d28e96c18ec61" args="(struct mwConference *conf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mwConference_removeClientData           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
remove associated client data if any, and call the cleanup function on the data as necessary 
<p>

</div>
</div><p>
<a class="anchor" name="5c3b16cc84d63dab6699a89a1d17c5c9"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_sendText" ref="5c3b16cc84d63dab6699a89a1d17c5c9" args="(struct mwConference *conf, const char *text)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mwConference_sendText           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>text</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
send a text message over an open conference 
<p>

</div>
</div><p>
<a class="anchor" name="8ea1c62150c4fc32a8e55c9c07731062"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_sendTyping" ref="8ea1c62150c4fc32a8e55c9c07731062" args="(struct mwConference *conf, gboolean typing)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mwConference_sendTyping           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gboolean&nbsp;</td>
          <td class="paramname"> <em>typing</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
send typing notification over an open conference 
<p>

</div>
</div><p>
<a class="anchor" name="8fb8832aedee72fd8047e4fbef752eb7"></a><!-- doxytag: member="mw_srvc_conf.h::mwConference_setClientData" ref="8fb8832aedee72fd8047e4fbef752eb7" args="(struct mwConference *conf, gpointer data, GDestroyNotify clear)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mwConference_setClientData           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwConference.html">mwConference</a> *&nbsp;</td>
          <td class="paramname"> <em>conf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gpointer&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">GDestroyNotify&nbsp;</td>
          <td class="paramname"> <em>clear</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
associate arbitrary client data and an optional cleanup function with a conference. 
<p>
If there is already client data with a clear function, it will not be called. 
</div>
</div><p>
<a class="anchor" name="82ad4285b9310ba22ea8552b2f477a0d"></a><!-- doxytag: member="mw_srvc_conf.h::mwServiceConference_getConferences" ref="82ad4285b9310ba22ea8552b2f477a0d" args="(struct mwServiceConference *srvc)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GList* mwServiceConference_getConferences           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwServiceConference.html">mwServiceConference</a> *&nbsp;</td>
          <td class="paramname"> <em>srvc</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
a <a class="el" href="structmwConference.html" title="A multi-user chat.">mwConference</a> list of the conferences in this service. 
<p>
The GList will need to be destroyed with g_list_free after use 
</div>
</div><p>
<a class="anchor" name="b23596a80b89b8700d598f499f98cf8a"></a><!-- doxytag: member="mw_srvc_conf.h::mwServiceConference_getHandler" ref="b23596a80b89b8700d598f499f98cf8a" args="(struct mwServiceConference *srvc)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwConferenceHandler.html">mwConferenceHandler</a>* mwServiceConference_getHandler           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwServiceConference.html">mwServiceConference</a> *&nbsp;</td>
          <td class="paramname"> <em>srvc</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the conference handler for the service </dd></dl>

<p>

</div>
</div><p>
<a class="anchor" name="67d53a162d0b826956de5406e5352680"></a><!-- doxytag: member="mw_srvc_conf.h::mwServiceConference_new" ref="67d53a162d0b826956de5406e5352680" args="(struct mwSession *sess, struct mwConferenceHandler *handler)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmwServiceConference.html">mwServiceConference</a>* mwServiceConference_new           </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structmwSession.html">mwSession</a> *&nbsp;</td>
          <td class="paramname"> <em>sess</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structmwConferenceHandler.html">mwConferenceHandler</a> *&nbsp;</td>
          <td class="paramname"> <em>handler</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Allocate a new conferencing service, attaching the given handler. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sess</em>&nbsp;</td><td>owning session </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>handler</em>&nbsp;</td><td>handler providing call-back functions for the service </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 19 09:10:34 2007 for meanwhile by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>