libinfinity-0.6-doc 0.6.7-1build1 / usr / share / gtk-doc / html / libinfinity-0.6 / InfRequest.html

This file is indexed.

/usr/share/gtk-doc/html/libinfinity-0.6/InfRequest.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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfRequest: 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="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfSessionProxy.html" title="InfSessionProxy">
<link rel="next" href="InfRequestResult.html" title="Result of an asynchronous request">
<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="#InfRequest.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#InfRequest.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
                  <a href="#InfRequest.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
                  <a href="#InfRequest.implementations" class="shortcut">Known Implementations</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#InfRequest.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#InfRequest.signals" class="shortcut">Signals</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="InfSessionProxy.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfRequestResult.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfRequest"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfRequest.top_of_page"></a>InfRequest</span></h2>
<p>InfRequest — Asynchronous request</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfRequest.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="InfRequest.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">
<span class="c_punctuation">(</span><a class="link" href="InfRequest.html#InfRequestFunc" title="InfRequestFunc ()">*InfRequestFunc</a><span class="c_punctuation">)</span> <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="InfRequest.html#inf-request-fail" title="inf_request_fail ()">inf_request_fail</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="InfRequest.html#inf-request-finish" title="inf_request_finish ()">inf_request_finish</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="InfRequest.html#inf-request-is-local" title="inf_request_is_local ()">inf_request_is_local</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfRequest.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gdouble</span></td>
<td class="property_name"><a class="link" href="InfRequest.html#InfRequest--progress" title="The “progress” property">progress</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfRequest.html#InfRequest--type" title="The “type” property">type</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfRequest.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfRequest.html#InfRequest-finished" title="The “finished” signal">finished</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfRequest.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"> </td>
<td class="function_name"><a class="link" href="InfRequest.html#InfRequest-struct" title="InfRequest">InfRequest</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfRequest.html#InfRequestIface" title="struct InfRequestIface">InfRequestIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfRequest.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GInterface
    <span class="lineart">╰──</span> InfRequest
</pre>
</div>
<div class="refsect1">
<a name="InfRequest.prerequisites"></a><h2>Prerequisites</h2>
<p>
InfRequest requires
 GObject.</p>
</div>
<div class="refsect1">
<a name="InfRequest.implementations"></a><h2>Known Implementations</h2>
<p>
InfRequest is implemented by
 <a class="link" href="InfcProgressRequest.html" title="InfcProgressRequest">InfcProgressRequest</a>,  <a class="link" href="InfcRequest.html" title="InfcRequest">InfcRequest</a>,  <a class="link" href="InfdProgressRequest.html" title="InfdProgressRequest">InfdProgressRequest</a> and  <a class="link" href="InfdRequest.html" title="InfdRequest">InfdRequest</a>.</p>
</div>
<div class="refsect1">
<a name="InfRequest.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libinfinity/common/inf-request.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="InfRequest.description"></a><h2>Description</h2>
<p><a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> represents a potentially asynchronous operation. This is a
basic interface which allows to query the type of the operation and
to be notified when the request finishes.</p>
</div>
<div class="refsect1">
<a name="InfRequest.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="InfRequestFunc"></a><h3>InfRequestFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*InfRequestFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> *request</code></em>,
                   <em class="parameter"><code>const <a class="link" href="InfRequestResult.html" title="Result of an asynchronous request"><span class="type">InfRequestResult</span></a> *result</code></em>,
                   <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
                   <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Signature of a signal handler for the <a class="link" href="InfRequest.html#InfRequest-finished" title="The “finished” signal"><span class="type">“finished”</span></a> signal.</p>
<div class="refsect3">
<a name="id-1.3.6.13.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>request</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> that emits the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfRequestResult.html" title="Result of an asynchronous request"><span class="type">InfRequestResult</span></a> which contains the result of the request.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Error information in case the request failed, or <code class="literal">NULL</code>
otherwise.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Additional data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-request-fail"></a><h3>inf_request_fail ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_request_fail (<em class="parameter"><code><a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> *request</code></em>,
                  <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
<p>Declares the request as failed by emitting the <a class="link" href="InfRequest.html#InfRequest-finished" title="The “finished” signal"><span class="type">“finished”</span></a>
signal with the given error.</p>
<div class="refsect3">
<a name="id-1.3.6.13.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>request</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span> describing the reason for why the request failed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-request-finish"></a><h3>inf_request_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_request_finish (<em class="parameter"><code><a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> *request</code></em>,
                    <em class="parameter"><code><a class="link" href="InfRequestResult.html" title="Result of an asynchronous request"><span class="type">InfRequestResult</span></a> *result</code></em>);</pre>
<p>Declares the request as succeeded by emitting the <a class="link" href="InfRequest.html#InfRequest-finished" title="The “finished” signal"><span class="type">“finished”</span></a>
signal with the given result. The function takes ownership of <em class="parameter"><code>result</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.6.13.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>request</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfRequestResult.html" title="Result of an asynchronous request"><span class="type">InfRequestResult</span></a> containing the result of the request.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-request-is-local"></a><h3>inf_request_is_local ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_request_is_local (<em class="parameter"><code><a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> *request</code></em>);</pre>
<p>Returns whether <em class="parameter"><code>request</code></em>
 is local or remote. A local request was triggered
by a local API call, whereas a remote request was caused by a remote
participant from the network.</p>
<div class="refsect3">
<a name="id-1.3.6.13.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>request</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.6.13.5.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the request is local and <code class="literal">FALSE</code> if it is remote.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfRequest.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfRequest-struct"></a><h3>InfRequest</h3>
<pre class="programlisting">typedef struct _InfRequest InfRequest;</pre>
<p><a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</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="InfRequestIface"></a><h3>struct InfRequestIface</h3>
<pre class="programlisting">struct InfRequestIface {
  void (*finished)(InfRequest* request,
                   const InfRequestResult* result,
                   const GError* error);

  gboolean (*is_local)(InfRequest* request);
};
</pre>
<p>Virtual functions of the <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> interface.</p>
<div class="refsect3">
<a name="id-1.3.6.14.3.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="InfRequestIface.finished"></a>finished</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler of the <a class="link" href="InfRequest.html#InfRequest-finished" title="The “finished” signal"><span class="type">“finished”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfRequestIface.is-local"></a>is_local</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to check whether the request is local or
remote.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfRequest.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfRequest--progress"></a><h3>The <code class="literal">“progress”</code> property</h3>
<pre class="programlisting">  “progress”                 <span class="type">gdouble</span></pre>
<p>Percentage of completion of the request.</p>
<p>Flags: Read</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="InfRequest--type"></a><h3>The <code class="literal">“type”</code> property</h3>
<pre class="programlisting">  “type”                     <span class="type">gchar</span> *</pre>
<p>A string identifier for the type of the request.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="InfRequest.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfRequest-finished"></a><h3>The <code class="literal">“finished”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a>       *request,
               <a class="link" href="InfRequestResult.html" title="Result of an asynchronous request"><span class="type">InfRequestResult</span></a> *result,
               <span class="type">gpointer</span>          error,
               <span class="type">gpointer</span>          user_data)</pre>
<p>This signal is emitted when the request finishes. If <em class="parameter"><code>error</code></em>
 is
non-<code class="literal">NULL</code> the request failed, otherwise it finished successfully.</p>
<div class="refsect3">
<a name="id-1.3.6.16.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>request</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> which finished.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfRequestResult.html" title="Result of an asynchronous request"><span class="type">InfRequestResult</span></a> which contains the result of the request.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Error information in case the request failed, or <code class="literal">NULL</code>
otherwise.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.