This file is indexed.

/usr/share/gtk-doc/html/libinfinity-0.6/InfCommunicationRegistry.html is in libinfinity-0.6-doc 0.6.7-1~deb8u1.

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
373
374
375
376
377
378
379
380
381
382
383
384
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libinfinity-0.6 Reference Manual: InfCommunicationRegistry</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="InfCommunicationMethod.html" title="InfCommunicationMethod">
<link rel="next" href="InfCommunicationCentralFactory.html" title="InfCommunicationCentralFactory">
<meta name="generator" content="GTK-Doc V1.21 (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="#InfCommunicationRegistry.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#InfCommunicationRegistry.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="InfCommunicationMethod.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfCommunicationCentralFactory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfCommunicationRegistry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfCommunicationRegistry.top_of_page"></a>InfCommunicationRegistry</span></h2>
<p>InfCommunicationRegistry — Sharing connections between multiple groups</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfCommunicationRegistry.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="InfCommunicationRegistry.functions"></a><h2>Functions</h2>
<div class="informaltable"><table 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="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()">inf_communication_registry_register</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="InfCommunicationRegistry.html#inf-communication-registry-unregister" title="inf_communication_registry_unregister ()">inf_communication_registry_unregister</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-is-registered" title="inf_communication_registry_is_registered ()">inf_communication_registry_is_registered</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="InfCommunicationRegistry.html#inf-communication-registry-send" title="inf_communication_registry_send ()">inf_communication_registry_send</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="InfCommunicationRegistry.html#inf-communication-registry-cancel-messages" title="inf_communication_registry_cancel_messages ()">inf_communication_registry_cancel_messages</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationRegistry.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table 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="InfCommunicationRegistry.html#InfCommunicationRegistry-struct" title="struct InfCommunicationRegistry">InfCommunicationRegistry</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfCommunicationRegistry.html#InfCommunicationRegistryClass" title="struct InfCommunicationRegistryClass">InfCommunicationRegistryClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationRegistry.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> InfCommunicationRegistry
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationRegistry.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libinfinity/communication/inf-communication-registry.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationRegistry.description"></a><h2>Description</h2>
<p><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> provides a way for <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>
implementations to share connections with other groups. Before using a
connection, call <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()"><code class="function">inf_communication_registry_register()</code></a>. Then, messages can
be sent to the group via <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-send" title="inf_communication_registry_send ()"><code class="function">inf_communication_registry_send()</code></a>.</p>
<p>The <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> calls <a class="link" href="InfCommunicationMethod.html#inf-communication-method-received" title="inf_communication_method_received ()"><code class="function">inf_communication_method_received()</code></a>
on your method when it received a message for the group,
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-enqueued" title="inf_communication_method_enqueued ()"><code class="function">inf_communication_method_enqueued()</code></a> when sending the message cannot be
cancelled anymore via <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-cancel-messages" title="inf_communication_registry_cancel_messages ()"><code class="function">inf_communication_registry_cancel_messages()</code></a> and
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-sent" title="inf_communication_method_sent ()"><code class="function">inf_communication_method_sent()</code></a> when the message has been sent.</p>
</div>
<div class="refsect1">
<a name="InfCommunicationRegistry.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-communication-registry-register"></a><h3>inf_communication_registry_register ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_registry_register (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                     <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>,
                                     <em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</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>Registers connection with <em class="parameter"><code>group</code></em>
. This allows sending messages to
<em class="parameter"><code>connection</code></em>
 via <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-send" title="inf_communication_registry_send ()"><code class="function">inf_communication_registry_send()</code></a>. For received messages,
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-received" title="inf_communication_method_received ()"><code class="function">inf_communication_method_received()</code></a> is called on <em class="parameter"><code>method</code></em>
.</p>
<p><em class="parameter"><code>connection</code></em>
 must have status <a class="link" href="InfXmlConnection.html#INF-XML-CONNECTION-OPEN:CAPS"><code class="literal">INF_XML_CONNECTION_OPEN</code></a>.</p>
<div class="refsect3">
<a name="id-1.7.9.9.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>registry</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>The group for which to register a connection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> used.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The connection to register.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-registry-unregister"></a><h3>inf_communication_registry_unregister ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_registry_unregister (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                       <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</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>Unregisters <em class="parameter"><code>connection</code></em>
 from <em class="parameter"><code>group</code></em>
. Incoming messages are no longer
reported to group's method, and <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-send" title="inf_communication_registry_send ()"><code class="function">inf_communication_registry_send()</code></a> can
no longer be called for <em class="parameter"><code>connection</code></em>
.</p>
<div class="refsect3">
<a name="id-1.7.9.9.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>registry</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>The group for which to unregister a connection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The connection to unregister.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-registry-is-registered"></a><h3>inf_communication_registry_is_registered ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_communication_registry_is_registered
                               (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</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>Returns whether <em class="parameter"><code>connection</code></em>
 has been registered for <em class="parameter"><code>group</code></em>
 with
<a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()"><code class="function">inf_communication_registry_register()</code></a>.</p>
<div class="refsect3">
<a name="id-1.7.9.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>registry</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>The group for which to check whether <em class="parameter"><code>connection</code></em>
is registered.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The connection to check for registration.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.9.9.4.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>connection</code></em>
has been registered, or <code class="literal">FALSE</code> otherwise.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-registry-send"></a><h3>inf_communication_registry_send ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_registry_send (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                 <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</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>,
                                 <em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>Sends an XML message to <em class="parameter"><code>connection</code></em>
. <em class="parameter"><code>connection</code></em>
 must have been registered
with <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()"><code class="function">inf_communication_registry_register()</code></a> before. If the message has been
sent, <a class="link" href="InfCommunicationMethod.html#inf-communication-method-sent" title="inf_communication_method_sent ()"><code class="function">inf_communication_method_sent()</code></a> is called on the method the
connection was registered with. <a class="link" href="InfCommunicationMethod.html#inf-communication-method-enqueued" title="inf_communication_method_enqueued ()"><code class="function">inf_communication_method_enqueued()</code></a> is
called when sending the message can no longer be cancelled via
<a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-cancel-messages" title="inf_communication_registry_cancel_messages ()"><code class="function">inf_communication_registry_cancel_messages()</code></a>.</p>
<p>This function takes ownership of <em class="parameter"><code>xml</code></em>
.</p>
<div class="refsect3">
<a name="id-1.7.9.9.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>registry</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>The group for which to send the message <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 registered <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>xml</p></td>
<td class="parameter_description"><p>The message to send.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-registry-cancel-messages"></a><h3>inf_communication_registry_cancel_messages ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_registry_cancel_messages
                               (<em class="parameter"><code><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> *registry</code></em>,
                                <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</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>Stops all messages scheduled to be sent to <em class="parameter"><code>connection</code></em>
 in <em class="parameter"><code>group</code></em>
 from being
sent.</p>
<div class="refsect3">
<a name="id-1.7.9.9.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>registry</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>The group for which to cancel messages.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A registered <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationRegistry.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfCommunicationRegistry-struct"></a><h3>struct InfCommunicationRegistry</h3>
<pre class="programlisting">struct InfCommunicationRegistry;</pre>
<p><a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</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="InfCommunicationRegistryClass"></a><h3>struct InfCommunicationRegistryClass</h3>
<pre class="programlisting">struct InfCommunicationRegistryClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>