/usr/share/gtk-doc/html/libinfinity-0.6/InfCommunicationObject.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 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfCommunicationObject: 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="InfCommunicationManager.html" title="InfCommunicationManager">
<link rel="next" href="InfCommunicationGroup.html" title="InfCommunicationGroup">
<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="#InfCommunicationObject.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfCommunicationObject.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#InfCommunicationObject.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#InfCommunicationObject.implementations" class="shortcut">Known Implementations</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="InfCommunicationManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfCommunicationGroup.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfCommunicationObject"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfCommunicationObject.top_of_page"></a>InfCommunicationObject</span></h2>
<p>InfCommunicationObject — Network message destinations</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfCommunicationObject.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="InfCommunicationObject.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="InfCommunicationObject.html#InfCommunicationScope" title="enum InfCommunicationScope"><span class="returnvalue">InfCommunicationScope</span></a>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationObject.html#inf-communication-object-received" title="inf_communication_object_received ()">inf_communication_object_received</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="InfCommunicationObject.html#inf-communication-object-enqueued" title="inf_communication_object_enqueued ()">inf_communication_object_enqueued</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="InfCommunicationObject.html#inf-communication-object-sent" title="inf_communication_object_sent ()">inf_communication_object_sent</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationObject.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">enum</td>
<td class="function_name"><a class="link" href="InfCommunicationObject.html#InfCommunicationScope" title="enum InfCommunicationScope">InfCommunicationScope</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="InfCommunicationObject.html#InfCommunicationObject-struct" title="InfCommunicationObject">InfCommunicationObject</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfCommunicationObject.html#InfCommunicationObjectIface" title="struct InfCommunicationObjectIface">InfCommunicationObjectIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GEnum
<span class="lineart">╰──</span> InfCommunicationScope
GInterface
<span class="lineart">╰──</span> InfCommunicationObject
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationObject.prerequisites"></a><h2>Prerequisites</h2>
<p>
InfCommunicationObject requires
GObject.</p>
</div>
<div class="refsect1">
<a name="InfCommunicationObject.implementations"></a><h2>Known Implementations</h2>
<p>
InfCommunicationObject is implemented by
<a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession">InfAdoptedSession</a>, <a class="link" href="InfChatSession.html" title="InfChatSession">InfChatSession</a>, <a class="link" href="InfSession.html" title="InfSession">InfSession</a>, <a class="link" href="InfcBrowser.html" title="InfcBrowser">InfcBrowser</a>, <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy">InfcSessionProxy</a>, <a class="link" href="InfdDirectory.html" title="InfdDirectory">InfdDirectory</a> and <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy">InfdSessionProxy</a>.</p>
</div>
<div class="refsect1">
<a name="InfCommunicationObject.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/communication/inf-communication-object.h>
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationObject.description"></a><h2>Description</h2>
<p>A <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a> is the destination of network messages sent
through the <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>. Each <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> is
associated with <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a>. Requests received by that group
are reported to the <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a> by calling
<a class="link" href="InfCommunicationObject.html#inf-communication-object-received" title="inf_communication_object_received ()"><code class="function">inf_communication_object_received()</code></a> on it. Messages sent to a member of
that group (via <a class="link" href="InfCommunicationGroup.html#inf-communication-group-send-message" title="inf_communication_group_send_message ()"><code class="function">inf_communication_group_send_message()</code></a>) are also reported
by calling <a class="link" href="InfCommunicationObject.html#inf-communication-object-sent" title="inf_communication_object_sent ()"><code class="function">inf_communication_object_sent()</code></a>.</p>
</div>
<div class="refsect1">
<a name="InfCommunicationObject.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-communication-object-received"></a><h3>inf_communication_object_received ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationObject.html#InfCommunicationScope" title="enum InfCommunicationScope"><span class="returnvalue">InfCommunicationScope</span></a>
inf_communication_object_received (<em class="parameter"><code><a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a> *object</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *conn</code></em>,
<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);</pre>
<p>This function is called when a <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> received data from
<em class="parameter"><code>connection</code></em>
belonging to a group whose communication object is <em class="parameter"><code>object</code></em>
.
This function should process the incoming data. If it could not process it,
then it should set <em class="parameter"><code>error</code></em>
.</p>
<p>It should return <a class="link" href="InfCommunicationObject.html#INF-COMMUNICATION-SCOPE-GROUP:CAPS"><code class="literal">INF_COMMUNICATION_SCOPE_GROUP</code></a> if the message is allowed
to be forwarded to other group members. Since recipients of forwarded
messages don't see the original sender (but just the forwarding host),
forwarding arbitrary messages could lead to a security problem in the worst
case.</p>
<p>For example, if, in central mode, a client sends an (invalid)
<add-node> request to the whole (InfDirectory) group, and the server
forwarded this to all clients, those clients would try to create a new node
although the server rejected the request. In decentral mode, this is not a
problem since all clients see where the message comes from, and can
themselves reject all messages not coming from the server.</p>
<div class="refsect3">
<a name="id-1.7.3.11.2.7"></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>object</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>conn</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> data was received from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>The received data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.11.2.8"></a><h4>Returns</h4>
<p> <a class="link" href="InfCommunicationObject.html#INF-COMMUNICATION-SCOPE-GROUP:CAPS"><code class="literal">INF_COMMUNICATION_SCOPE_GROUP</code></a> if the message is allowed to
be forwarded, <a class="link" href="InfCommunicationObject.html#INF-COMMUNICATION-SCOPE-PTP:CAPS"><code class="literal">INF_COMMUNICATION_SCOPE_PTP</code></a> if not.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-object-enqueued"></a><h3>inf_communication_object_enqueued ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_object_enqueued (<em class="parameter"><code><a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a> *object</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *conn</code></em>,
<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);</pre>
<p>This function is called, when an XML message scheduled to be sent via
<a class="link" href="InfCommunicationGroup.html#inf-communication-group-send-message" title="inf_communication_group_send_message ()"><code class="function">inf_communication_group_send_message()</code></a> or
<a class="link" href="InfCommunicationGroup.html#inf-communication-group-send-group-message" title="inf_communication_group_send_group_message ()"><code class="function">inf_communication_group_send_group_message()</code></a> cannot be cancelled anymore,
because it was already passed to <em class="parameter"><code>conn</code></em>
.</p>
<div class="refsect3">
<a name="id-1.7.3.11.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>object</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>conn</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>The XML data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-object-sent"></a><h3>inf_communication_object_sent ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_object_sent (<em class="parameter"><code><a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a> *object</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *conn</code></em>,
<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);</pre>
<p>This function is called when a XML message sent via
<a class="link" href="InfCommunicationGroup.html#inf-communication-group-send-message" title="inf_communication_group_send_message ()"><code class="function">inf_communication_group_send_message()</code></a> or
<a class="link" href="InfCommunicationGroup.html#inf-communication-group-send-group-message" title="inf_communication_group_send_group_message ()"><code class="function">inf_communication_group_send_group_message()</code></a> has actually been sent out.</p>
<div class="refsect3">
<a name="id-1.7.3.11.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>object</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>conn</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node</p></td>
<td class="parameter_description"><p>The sent data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationObject.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfCommunicationScope"></a><h3>enum InfCommunicationScope</h3>
<p><a class="link" href="InfCommunicationObject.html#InfCommunicationScope" title="enum InfCommunicationScope"><span class="type">InfCommunicationScope</span></a> specifies to which hosts a message belongs.</p>
<div class="refsect3">
<a name="id-1.7.3.12.2.4"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="INF-COMMUNICATION-SCOPE-PTP:CAPS"></a>INF_COMMUNICATION_SCOPE_PTP</p></td>
<td class="enum_member_description">
<p>The message is sent from one group member to
another.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-COMMUNICATION-SCOPE-GROUP:CAPS"></a>INF_COMMUNICATION_SCOPE_GROUP</p></td>
<td class="enum_member_description">
<p>The message is sent to all group members.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfCommunicationObject-struct"></a><h3>InfCommunicationObject</h3>
<pre class="programlisting">typedef struct _InfCommunicationObject InfCommunicationObject;</pre>
<p><a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</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="InfCommunicationObjectIface"></a><h3>struct InfCommunicationObjectIface</h3>
<pre class="programlisting">struct InfCommunicationObjectIface {
InfCommunicationScope (*received)(InfCommunicationObject* object,
InfXmlConnection* conn,
xmlNodePtr node);
void (*enqueued)(InfCommunicationObject* object,
InfXmlConnection* conn,
xmlNodePtr node);
void (*sent)(InfCommunicationObject* object,
InfXmlConnection* conn,
xmlNodePtr node);
};
</pre>
<p>The virtual methods of <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a>. These are called by the
<a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> when appropriate.</p>
<div class="refsect3">
<a name="id-1.7.3.12.4.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationObjectIface.received"></a>received</code></em> ()</p></td>
<td class="struct_member_description"><p>Called when a message for the group related to this
<a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a> was received.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationObjectIface.enqueued"></a>enqueued</code></em> ()</p></td>
<td class="struct_member_description"><p>Called when a message to be sent to another group member has
been enqueued, which means sending it can no longer be cancelled via
<a class="link" href="InfCommunicationGroup.html#inf-communication-group-cancel-messages" title="inf_communication_group_cancel_messages ()"><code class="function">inf_communication_group_cancel_messages()</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationObjectIface.sent"></a>sent</code></em> ()</p></td>
<td class="struct_member_description"><p>Called when a message has been sent to another group member of the
group related no this <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationObject.see-also"></a><h2>See Also</h2>
<p><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>
|