/usr/share/gtk-doc/html/libinfinity-0.6/InfCommunicationHostedGroup.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfCommunicationHostedGroup: 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="InfCommunicationGroup.html" title="InfCommunicationGroup">
<link rel="next" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup">
<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="#InfCommunicationHostedGroup.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfCommunicationHostedGroup.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="InfCommunicationGroup.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfCommunicationJoinedGroup.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfCommunicationHostedGroup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfCommunicationHostedGroup.top_of_page"></a>InfCommunicationHostedGroup</span></h2>
<p>InfCommunicationHostedGroup — Communication group opened by the local host</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfCommunicationHostedGroup.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="InfCommunicationHostedGroup.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationHostedGroup.html#inf-communication-hosted-group-add-method" title="inf_communication_hosted_group_add_method ()">inf_communication_hosted_group_add_method</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="InfCommunicationHostedGroup.html#inf-communication-hosted-group-add-member" title="inf_communication_hosted_group_add_member ()">inf_communication_hosted_group_add_member</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="InfCommunicationHostedGroup.html#inf-communication-hosted-group-remove-member" title="inf_communication_hosted_group_remove_member ()">inf_communication_hosted_group_remove_member</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationHostedGroup.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="InfCommunicationHostedGroup.html#InfCommunicationHostedGroup-struct" title="struct InfCommunicationHostedGroup">InfCommunicationHostedGroup</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfCommunicationHostedGroup.html#InfCommunicationHostedGroupClass" title="struct InfCommunicationHostedGroupClass">InfCommunicationHostedGroupClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationHostedGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup">InfCommunicationGroup</a>
<span class="lineart">╰──</span> InfCommunicationHostedGroup
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationHostedGroup.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/communication/inf-communication-hosted-group.h>
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationHostedGroup.description"></a><h2>Description</h2>
<p><a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a> is a <a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a> opened on
the local host. It allows adding other hosts to the group via
<a class="link" href="InfCommunicationHostedGroup.html#inf-communication-hosted-group-add-member" title="inf_communication_hosted_group_add_member ()"><code class="function">inf_communication_hosted_group_add_member()</code></a>, and to remove hosts via
<a class="link" href="InfCommunicationHostedGroup.html#inf-communication-hosted-group-remove-member" title="inf_communication_hosted_group_remove_member ()"><code class="function">inf_communication_hosted_group_remove_member()</code></a>.</p>
</div>
<div class="refsect1">
<a name="InfCommunicationHostedGroup.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-communication-hosted-group-add-method"></a><h3>inf_communication_hosted_group_add_method ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_hosted_group_add_method
(<em class="parameter"><code><a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a> *group</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *method</code></em>);</pre>
<p>Adds a method to the hosted group. When a connection from a given network
is added to the group the first time, a <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> is
instantiated to handle messaging for the group within this network.
The first method added will be tried first. If the communication manager
does support it (meaning <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
the connection's network and the chosen method returns non-<code class="literal">NULL</code>), then it
will be used, otherwise the next method will be tried, etc. If no method
is supported, or no methods are added to the group, then the "central"
method will be used as a fallback.</p>
<div class="refsect3">
<a name="id-1.7.5.9.2.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>group</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method</p></td>
<td class="parameter_description"><p>The method name to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-hosted-group-add-member"></a><h3>inf_communication_hosted_group_add_member ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_hosted_group_add_member
(<em class="parameter"><code><a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a> *group</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>Adds <em class="parameter"><code>connection</code></em>
as a member to <em class="parameter"><code>group</code></em>
. On the remote site, a
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> with the same name and method used for
<em class="parameter"><code>connection</code></em>
(see <a class="link" href="InfCommunicationGroup.html#inf-communication-group-get-method-for-connection" title="inf_communication_group_get_method_for_connection ()"><code class="function">inf_communication_group_get_method_for_connection()</code></a>)
needs to be created for successful communication.</p>
<div class="refsect3">
<a name="id-1.7.5.9.3.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>group</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> to add to group.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-hosted-group-remove-member"></a><h3>inf_communication_hosted_group_remove_member ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_hosted_group_remove_member
(<em class="parameter"><code><a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a> *grp</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>Removes <em class="parameter"><code>connection</code></em>
's membership from <em class="parameter"><code>group</code></em>
. On the remote site, the
corresponding <a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> needs to be freed.</p>
<div class="refsect3">
<a name="id-1.7.5.9.4.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>grp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>InfXmlConnection</code></em>
to remove from the group.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationHostedGroup.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfCommunicationHostedGroup-struct"></a><h3>struct InfCommunicationHostedGroup</h3>
<pre class="programlisting">struct InfCommunicationHostedGroup;</pre>
<p><a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</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="InfCommunicationHostedGroupClass"></a><h3>struct InfCommunicationHostedGroupClass</h3>
<pre class="programlisting">struct InfCommunicationHostedGroupClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationHostedGroup.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>, <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|