This file is indexed.

/usr/share/gtk-doc/html/libinfinity-0.6/InfStandaloneIo.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
<!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: InfStandaloneIo</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="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfIo.html" title="InfIo">
<link rel="next" href="libinfinity-0.6-InfAsyncOperation.html" title="InfAsyncOperation">
<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="#InfStandaloneIo.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#InfStandaloneIo.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#InfStandaloneIo.implemented-interfaces" class="shortcut">Implemented Interfaces</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfIo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libinfinity-0.6-InfAsyncOperation.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfStandaloneIo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfStandaloneIo.top_of_page"></a>InfStandaloneIo</span></h2>
<p>InfStandaloneIo — Simple event loop implementation</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfStandaloneIo.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="InfStandaloneIo.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">
<a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="returnvalue">InfStandaloneIo</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfStandaloneIo.html#inf-standalone-io-new" title="inf_standalone_io_new ()">inf_standalone_io_new</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="InfStandaloneIo.html#inf-standalone-io-iteration" title="inf_standalone_io_iteration ()">inf_standalone_io_iteration</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="InfStandaloneIo.html#inf-standalone-io-iteration-timeout" title="inf_standalone_io_iteration_timeout ()">inf_standalone_io_iteration_timeout</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="InfStandaloneIo.html#inf-standalone-io-loop" title="inf_standalone_io_loop ()">inf_standalone_io_loop</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="InfStandaloneIo.html#inf-standalone-io-loop-quit" title="inf_standalone_io_loop_quit ()">inf_standalone_io_loop_quit</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="InfStandaloneIo.html#inf-standalone-io-loop-running" title="inf_standalone_io_loop_running ()">inf_standalone_io_loop_running</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfStandaloneIo.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="InfStandaloneIo.html#InfStandaloneIo-struct" title="struct InfStandaloneIo">InfStandaloneIo</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfStandaloneIo.html#InfStandaloneIoClass" title="struct InfStandaloneIoClass">InfStandaloneIoClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfStandaloneIo.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> InfStandaloneIo
</pre>
</div>
<div class="refsect1">
<a name="InfStandaloneIo.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfStandaloneIo implements
 <a class="link" href="InfIo.html" title="InfIo">InfIo</a>.</p>
</div>
<div class="refsect1">
<a name="InfStandaloneIo.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libinfinity/common/inf-standalone-io.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="InfStandaloneIo.description"></a><h2>Description</h2>
<p><a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a> is a simple implementation of the <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> interface. It
implements a basic application event loop with support for listening on
sockets, scheduling timeouts and inter-thread notifications. The class
is fully thread-safe.</p>
<p>This class can be perfectly used for all functions in libinfinity that
require a <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object to wait for events. If, on top of that more
functionality is required, or the main loop needs to be integrated with
another library such as a UI toolkit, a custom class should be created
instead which implements the <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> interface. For the GTK+ toolkit, there
is <span class="type">InfGtkIo</span> in the libinfgtk library, to integrate with the Glib main
loop.</p>
</div>
<div class="refsect1">
<a name="InfStandaloneIo.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-standalone-io-new"></a><h3>inf_standalone_io_new ()</h3>
<pre class="programlisting"><a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="returnvalue">InfStandaloneIo</span></a> *
inf_standalone_io_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.25.10.2.5"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a>. Free with <code class="function">g_object_unref()</code> when no longer
needed.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-standalone-io-iteration"></a><h3>inf_standalone_io_iteration ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_standalone_io_iteration (<em class="parameter"><code><a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a> *io</code></em>);</pre>
<p>Performs a single iteration of <em class="parameter"><code>io</code></em>
. The call will block until a first
event has occured. Then, it will process that event and return.</p>
<div class="refsect3">
<a name="id-1.3.25.10.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-standalone-io-iteration-timeout"></a><h3>inf_standalone_io_iteration_timeout ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_standalone_io_iteration_timeout (<em class="parameter"><code><a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a> *io</code></em>,
                                     <em class="parameter"><code><span class="type">guint</span> timeout</code></em>);</pre>
<p>Performs a single iteration of <em class="parameter"><code>io</code></em>
. The call will block until either an
event occured or <em class="parameter"><code>timeout</code></em>
 milliseconds have elapsed. If an event occured,
the event will be processed before returning.</p>
<div class="refsect3">
<a name="id-1.3.25.10.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout</p></td>
<td class="parameter_description"><p>Maximum number of milliseconds to block.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-standalone-io-loop"></a><h3>inf_standalone_io_loop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_standalone_io_loop (<em class="parameter"><code><a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a> *io</code></em>);</pre>
<p>This call will cause <em class="parameter"><code>io</code></em>
 to wait for events and process them, but not
return until <a class="link" href="InfStandaloneIo.html#inf-standalone-io-loop-quit" title="inf_standalone_io_loop_quit ()"><code class="function">inf_standalone_io_loop_quit()</code></a> is called.</p>
<div class="refsect3">
<a name="id-1.3.25.10.5.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-standalone-io-loop-quit"></a><h3>inf_standalone_io_loop_quit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_standalone_io_loop_quit (<em class="parameter"><code><a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a> *io</code></em>);</pre>
<p>Exits a loop in which <em class="parameter"><code>io</code></em>
 is running through a call to
<a class="link" href="InfStandaloneIo.html#inf-standalone-io-loop" title="inf_standalone_io_loop ()"><code class="function">inf_standalone_io_loop()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.25.10.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-standalone-io-loop-running"></a><h3>inf_standalone_io_loop_running ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_standalone_io_loop_running (<em class="parameter"><code><a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a> *io</code></em>);</pre>
<p>Returns whether <em class="parameter"><code>io</code></em>
 runs currently in a loop initiated with
<a class="link" href="InfStandaloneIo.html#inf-standalone-io-loop" title="inf_standalone_io_loop ()"><code class="function">inf_standalone_io_loop()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.25.10.7.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.25.10.7.6"></a><h4>Returns</h4>
<p> Whether <em class="parameter"><code>io</code></em>
runs in a loop.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfStandaloneIo.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfStandaloneIo-struct"></a><h3>struct InfStandaloneIo</h3>
<pre class="programlisting">struct InfStandaloneIo;</pre>
<p><a class="link" href="InfStandaloneIo.html" title="InfStandaloneIo"><span class="type">InfStandaloneIo</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="InfStandaloneIoClass"></a><h3>struct InfStandaloneIoClass</h3>
<pre class="programlisting">struct InfStandaloneIoClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
<div class="refsect1">
<a name="InfStandaloneIo.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a></p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>