/usr/share/gtk-doc/html/libinfinity-0.6/InfCommunicationManager.html is in libinfinity-0.6-doc 0.6.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfCommunicationManager: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch06.html" title="Network abstraction">
<link rel="prev" href="ch06.html" title="Network abstraction">
<link rel="next" href="InfCommunicationObject.html" title="InfCommunicationObject">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#InfCommunicationManager.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfCommunicationManager.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch06.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfCommunicationObject.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfCommunicationManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfCommunicationManager.top_of_page"></a>InfCommunicationManager</span></h2>
<p>InfCommunicationManager — Handling multiple communication sessions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfCommunicationManager.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="InfCommunicationManager.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="returnvalue">InfCommunicationManager</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfCommunicationManager.html#inf-communication-manager-new" title="inf_communication_manager_new ()">inf_communication_manager_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="returnvalue">InfCommunicationHostedGroup</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfCommunicationManager.html#inf-communication-manager-open-group" title="inf_communication_manager_open_group ()">inf_communication_manager_open_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="returnvalue">InfCommunicationJoinedGroup</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfCommunicationManager.html#inf-communication-manager-join-group" title="inf_communication_manager_join_group ()">inf_communication_manager_join_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationManager.html#inf-communication-manager-add-factory" title="inf_communication_manager_add_factory ()">inf_communication_manager_add_factory</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="returnvalue">InfCommunicationFactory</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfCommunicationManager.html#inf-communication-manager-get-factory-for" title="inf_communication_manager_get_factory_for ()">inf_communication_manager_get_factory_for</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationManager.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfCommunicationManager.html#InfCommunicationManager-struct" title="struct InfCommunicationManager">InfCommunicationManager</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfCommunicationManager.html#InfCommunicationManagerClass" title="struct InfCommunicationManagerClass">InfCommunicationManagerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> InfCommunicationManager
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationManager.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/communication/inf-communication-manager.h>
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationManager.description"></a><h2>Description</h2>
<p><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> manages multiple communication sessions
represented by <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>. A <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> provides an
easy way to send messages between group members, possibly sharing
connections with other groups handled by the same <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.</p>
</div>
<div class="refsect1">
<a name="InfCommunicationManager.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-communication-manager-new"></a><h3>inf_communication_manager_new ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="returnvalue">InfCommunicationManager</span></a> *
inf_communication_manager_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.</p>
<div class="refsect3">
<a name="id-1.7.2.9.2.5"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-manager-open-group"></a><h3>inf_communication_manager_open_group ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="returnvalue">InfCommunicationHostedGroup</span></a> *
inf_communication_manager_open_group (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> * const*methods</code></em>);</pre>
<p>Opens a new communication group published by the local host. <em class="parameter"><code>group_name</code></em>
is an identifier for the group via which other hosts can join the group
using <a class="link" href="InfCommunicationManager.html#inf-communication-manager-join-group" title="inf_communication_manager_join_group ()"><code class="function">inf_communication_manager_join_group()</code></a>. It needs to be unique among
all groups opened by the local host.</p>
<p><em class="parameter"><code>methods</code></em>
specifies what communication methods the group should use, in
order of priority. If a method is not supported for a given network, then
the next one in the array is tried. If none is supported, then the
"central" method will be used, which is guaranteed to be supported for
all networks.</p>
<div class="refsect3">
<a name="id-1.7.2.9.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group_name</p></td>
<td class="parameter_description"><p>A name for the new group.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>methods</p></td>
<td class="parameter_description"><p>Methods to support, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.9.3.7"></a><h4>Returns</h4>
<p> A <a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a>. Free with <code class="function">g_object_unref()</code> to
leave the group.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-manager-join-group"></a><h3>inf_communication_manager_join_group ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="returnvalue">InfCommunicationJoinedGroup</span></a> *
inf_communication_manager_join_group (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group_name</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *publisher_conn</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *method</code></em>);</pre>
<p>Joins a communication group published by a remote host. <em class="parameter"><code>publisher_conn</code></em>
needs to be a to the publishing host with status <a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-OPEN:CAPS"><code class="literal">INF_XML_CONNECTION_OPEN</code></a>
or <a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-OPENING:CAPS"><code class="literal">INF_XML_CONNECTION_OPENING</code></a>. <em class="parameter"><code>group_name</code></em>
specifies the name of the group
to join.</p>
<p><em class="parameter"><code>method</code></em>
specifies the communication method to use. It must match the
communication method the publisher has chosen for <em class="parameter"><code>publisher_conn</code></em>
's network
(see <a class="link" href="InfCommunicationGroup.html#inf-communication-group-get-method-for-network" title="inf_communication_group_get_method_for_network ()"><code class="function">inf_communication_group_get_method_for_network()</code></a>). The function
returns <code class="literal">NULL</code> if <em class="parameter"><code>method</code></em>
is not supported (which means
<a class="link" href="InfCommunicationManager.html#inf-communication-manager-get-factory-for" title="inf_communication_manager_get_factory_for ()"><code class="function">inf_communication_manager_get_factory_for()</code></a> for <em class="parameter"><code>publisher_conn</code></em>
's network
and <em class="parameter"><code>method</code></em>
returns <code class="literal">NULL</code>).</p>
<div class="refsect3">
<a name="id-1.7.2.9.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group_name</p></td>
<td class="parameter_description"><p>The group to join.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>publisher_conn</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> to the publishing host.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method</p></td>
<td class="parameter_description"><p>The communication method to use.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.9.4.7"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a>, or <code class="literal">NULL</code>. Free with
<code class="function">g_object_unref()</code> to leave the group.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-manager-add-factory"></a><h3>inf_communication_manager_add_factory ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_manager_add_factory (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a> *factory</code></em>);</pre>
<p>Adds a new <a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a> to <em class="parameter"><code>manager</code></em>
. This makes <em class="parameter"><code>manager</code></em>
support all method/network combinations that <em class="parameter"><code>factory</code></em>
supports. If multiple
added factories support the same combination, the one which was added first
will be used to instantiate the <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.</p>
<div class="refsect3">
<a name="id-1.7.2.9.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>factory</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a> to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-manager-get-factory-for"></a><h3>inf_communication_manager_get_factory_for ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="returnvalue">InfCommunicationFactory</span></a> *
inf_communication_manager_get_factory_for
(<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *network</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *method_name</code></em>);</pre>
<p>Returns the <a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a> that <em class="parameter"><code>manager</code></em>
will use to instantiate
a <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> for <em class="parameter"><code>method_name</code></em>
on <em class="parameter"><code>network</code></em>
, or <code class="literal">NULL</code> if the
network/method combination is not supported.</p>
<div class="refsect3">
<a name="id-1.7.2.9.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>network</p></td>
<td class="parameter_description"><p>A network identifier.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method_name</p></td>
<td class="parameter_description"><p>A method name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.9.6.6"></a><h4>Returns</h4>
<p> A <a class="link" href="InfCommunicationFactory.html" title="InfCommunicationFactory"><span class="type">InfCommunicationFactory</span></a>, or <code class="literal">NULL</code>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationManager.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfCommunicationManager-struct"></a><h3>struct InfCommunicationManager</h3>
<pre class="programlisting">struct InfCommunicationManager;</pre>
<p><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> is an opaque data type. You should only access it
via the public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfCommunicationManagerClass"></a><h3>struct InfCommunicationManagerClass</h3>
<pre class="programlisting">struct InfCommunicationManagerClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|