/usr/share/gtk-doc/html/libinfinity-0.5/InfcRequest.html is in libinfinity-0.5-doc 0.5.5-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfcRequest</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinfinity-0.5 Reference Manual">
<link rel="up" href="ch04.html" title="Libinfinity client side API">
<link rel="prev" href="InfcUserRequest.html" title="InfcUserRequest">
<link rel="next" href="InfcRequestManager.html" title="InfcRequestManager">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="InfcUserRequest.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.5 Reference Manual</th>
<td><a accesskey="n" href="InfcRequestManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfcRequest.synopsis" class="shortcut">Top</a>
|
<a href="#InfcRequest.description" class="shortcut">Description</a>
|
<a href="#InfcRequest.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#InfcRequest.properties" class="shortcut">Properties</a>
|
<a href="#InfcRequest.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="InfcRequest"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfcRequest.top_of_page"></a>InfcRequest</span></h2>
<p>InfcRequest — Requests sent to server</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfcRequest.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="InfcRequest.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libinfinity/client/infc-request.h>
<a class="link" href="InfcRequest.html#InfcRequest-struct" title="InfcRequest">InfcRequest</a>;
struct <a class="link" href="InfcRequest.html#InfcRequestClass" title="struct InfcRequestClass">InfcRequestClass</a>;
<span class="returnvalue">guint</span> <a class="link" href="InfcRequest.html#infc-request-get-seq" title="infc_request_get_seq ()">infc_request_get_seq</a> (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="InfcRequest.html#infc-request-get-name" title="infc_request_get_name ()">infc_request_get_name</a> (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfcRequest.html#infc-request-failed" title="infc_request_failed ()">infc_request_failed</a> (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>,
<em class="parameter"><code><span class="type">GError</span> *error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="InfcRequest.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----InfcRequest
+----<a class="link" href="InfcExploreRequest.html" title="InfcExploreRequest">InfcExploreRequest</a>
+----<a class="link" href="InfcNodeRequest.html" title="InfcNodeRequest">InfcNodeRequest</a>
+----<a class="link" href="InfcUserRequest.html" title="InfcUserRequest">InfcUserRequest</a>
</pre>
</div>
<div class="refsect1">
<a name="InfcRequest.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="InfcRequest.html#InfcRequest--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
"<a class="link" href="InfcRequest.html#InfcRequest--seq" title='The "seq" property'>seq</a>" <span class="type">guint</span> : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="InfcRequest.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="InfcRequest.html#InfcRequest-failed" title='The "failed" signal'>failed</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="InfcRequest.description"></a><h2>Description</h2>
<p>
A <a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> represents a request that was sent to the server. It can
be used to get information related to that request and to be notified
when the request fails or finishes.
</p>
<p>
<a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> is the base class for other requests and only has the
<a class="link" href="InfcRequest.html#InfcRequest-failed" title='The "failed" signal'><span class="type">"failed"</span></a> signal. Use signals from specific requests such as
<a class="link" href="InfcNodeRequest.html" title="InfcNodeRequest"><span class="type">InfcNodeRequest</span></a> to get further notification. Every request has a name
and a sequence number. The sequence number is used in the server reply to
refer to a specific request and normally of no use for developers using
the infinote API.
</p>
</div>
<div class="refsect1">
<a name="InfcRequest.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="InfcRequest-struct"></a><h3>InfcRequest</h3>
<pre class="programlisting">typedef struct _InfcRequest InfcRequest;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="InfcRequestClass"></a><h3>struct InfcRequestClass</h3>
<pre class="programlisting">struct InfcRequestClass {
GObjectClass parent_class;
/* Signals */
void (*failed)(InfcRequest* request, GError* error);
void (*unused1)(void);
void (*usused2)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="infc-request-get-seq"></a><h3>infc_request_get_seq ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> infc_request_get_seq (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>);</pre>
<p>
Returns the sequence identifier for this request.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>request</code></em> :</span></p></td>
<td>A <a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The sequence number for <span class="type">request</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="infc-request-get-name"></a><h3>infc_request_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * infc_request_get_name (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>);</pre>
<p>
Returns the name of the request.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>request</code></em> :</span></p></td>
<td>A <a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of <em class="parameter"><code>request</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="infc-request-failed"></a><h3>infc_request_failed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> infc_request_failed (<em class="parameter"><code><a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request</code></em>,
<em class="parameter"><code><span class="type">GError</span> *error</code></em>);</pre>
<p>
Emits the "failed" signal on <em class="parameter"><code>request</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>request</code></em> :</span></p></td>
<td>A <a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <span class="type">GError</span>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="InfcRequest.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfcRequest--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting"> "name" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
<p>Name of the request.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfcRequest--seq"></a><h3>The <code class="literal">"seq"</code> property</h3>
<pre class="programlisting"> "seq" <span class="type">guint</span> : Read / Write / Construct Only</pre>
<p>Identifier for this request.</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="InfcRequest.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfcRequest-failed"></a><h3>The <code class="literal">"failed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a> *request,
<span class="type">gpointer</span> error,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
Emitted when the request could not be processed on the server side.
<em class="parameter"><code>error</code></em> holds additional information on why the request failed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>request</code></em> :</span></p></td>
<td>The failed <a class="link" href="InfcRequest.html" title="InfcRequest"><span class="type">InfcRequest</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A pointer to a <span class="type">GError</span> object with details on the error.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="InfcRequest.see-also"></a><h2>See Also</h2>
<a class="link" href="InfcUserRequest.html" title="InfcUserRequest"><span class="type">InfcUserRequest</span></a>, <a class="link" href="InfcNodeRequest.html" title="InfcNodeRequest"><span class="type">InfcNodeRequest</span></a>, <a class="link" href="InfcExploreRequest.html" title="InfcExploreRequest"><span class="type">InfcExploreRequest</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|