6badfefe738fedc0db3640304e5d5bb73a89cb92
[profile/ivi/libsoup2.4.git] / docs / reference / html / libsoup-2.4-soup-status.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>soup-status</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="libsoup Reference Manual">
8 <link rel="up" href="ch02.html" title="Core API">
9 <link rel="prev" href="SoupSessionSync.html" title="SoupSessionSync">
10 <link rel="next" href="SoupURI.html" title="SoupURI">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="SoupSessionSync.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">libsoup Reference Manual</th>
21 <td><a accesskey="n" href="SoupURI.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#libsoup-2.4-soup-status.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#libsoup-2.4-soup-status.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="libsoup-2.4-soup-status"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="libsoup-2.4-soup-status.top_of_page"></a>soup-status</span></h2>
34 <p>soup-status — HTTP (and libsoup) status codes</p>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="libsoup-2.4-soup-status.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include &lt;libsoup/soup.h&gt;
42
43 #define             <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-TRANSPORT-ERROR:CAPS" title="SOUP_STATUS_IS_TRANSPORT_ERROR()">SOUP_STATUS_IS_TRANSPORT_ERROR</a>      (status)
44 #define             <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-INFORMATIONAL:CAPS" title="SOUP_STATUS_IS_INFORMATIONAL()">SOUP_STATUS_IS_INFORMATIONAL</a>        (status)
45 #define             <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-SUCCESSFUL:CAPS" title="SOUP_STATUS_IS_SUCCESSFUL()">SOUP_STATUS_IS_SUCCESSFUL</a>           (status)
46 #define             <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-REDIRECTION:CAPS" title="SOUP_STATUS_IS_REDIRECTION()">SOUP_STATUS_IS_REDIRECTION</a>          (status)
47 #define             <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-CLIENT-ERROR:CAPS" title="SOUP_STATUS_IS_CLIENT_ERROR()">SOUP_STATUS_IS_CLIENT_ERROR</a>         (status)
48 #define             <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-SERVER-ERROR:CAPS" title="SOUP_STATUS_IS_SERVER_ERROR()">SOUP_STATUS_IS_SERVER_ERROR</a>         (status)
49 enum                <a class="link" href="libsoup-2.4-soup-status.html#SoupKnownStatusCode" title="enum SoupKnownStatusCode">SoupKnownStatusCode</a>;
50 const <span class="returnvalue">char</span> *        <a class="link" href="libsoup-2.4-soup-status.html#soup-status-get-phrase" title="soup_status_get_phrase ()">soup_status_get_phrase</a>              (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> status_code</code></em>);
51 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="libsoup-2.4-soup-status.html#soup-status-proxify" title="soup_status_proxify ()">soup_status_proxify</a>                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> status_code</code></em>);
52
53 #define             <a class="link" href="libsoup-2.4-soup-status.html#SOUP-HTTP-ERROR:CAPS" title="SOUP_HTTP_ERROR">SOUP_HTTP_ERROR</a>
54 </pre>
55 </div>
56 <div class="refsect1">
57 <a name="libsoup-2.4-soup-status.description"></a><h2>Description</h2>
58 </div>
59 <div class="refsect1">
60 <a name="libsoup-2.4-soup-status.details"></a><h2>Details</h2>
61 <div class="refsect2">
62 <a name="SOUP-STATUS-IS-TRANSPORT-ERROR:CAPS"></a><h3>SOUP_STATUS_IS_TRANSPORT_ERROR()</h3>
63 <pre class="programlisting">#define SOUP_STATUS_IS_TRANSPORT_ERROR(status) ((status) &gt;  0   &amp;&amp; (status) &lt; 100)
64 </pre>
65 <p>
66 Tests if <em class="parameter"><code>status</code></em> is a libsoup transport error.
67 </p>
68 <div class="variablelist"><table border="0">
69 <col align="left" valign="top">
70 <tbody>
71 <tr>
72 <td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
73 <td>a status code</td>
74 </tr>
75 <tr>
76 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
77 <td>
78 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
79 </td>
80 </tr>
81 </tbody>
82 </table></div>
83 </div>
84 <hr>
85 <div class="refsect2">
86 <a name="SOUP-STATUS-IS-INFORMATIONAL:CAPS"></a><h3>SOUP_STATUS_IS_INFORMATIONAL()</h3>
87 <pre class="programlisting">#define SOUP_STATUS_IS_INFORMATIONAL(status)   ((status) &gt;= 100 &amp;&amp; (status) &lt; 200)
88 </pre>
89 <p>
90 Tests if <em class="parameter"><code>status</code></em> is an Informational (1xx) response.
91 </p>
92 <div class="variablelist"><table border="0">
93 <col align="left" valign="top">
94 <tbody>
95 <tr>
96 <td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
97 <td>an HTTP status code</td>
98 </tr>
99 <tr>
100 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
101 <td>
102 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
103 </td>
104 </tr>
105 </tbody>
106 </table></div>
107 </div>
108 <hr>
109 <div class="refsect2">
110 <a name="SOUP-STATUS-IS-SUCCESSFUL:CAPS"></a><h3>SOUP_STATUS_IS_SUCCESSFUL()</h3>
111 <pre class="programlisting">#define SOUP_STATUS_IS_SUCCESSFUL(status)      ((status) &gt;= 200 &amp;&amp; (status) &lt; 300)
112 </pre>
113 <p>
114 Tests if <em class="parameter"><code>status</code></em> is a Successful (2xx) response.
115 </p>
116 <div class="variablelist"><table border="0">
117 <col align="left" valign="top">
118 <tbody>
119 <tr>
120 <td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
121 <td>an HTTP status code</td>
122 </tr>
123 <tr>
124 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
125 <td>
126 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
127 </td>
128 </tr>
129 </tbody>
130 </table></div>
131 </div>
132 <hr>
133 <div class="refsect2">
134 <a name="SOUP-STATUS-IS-REDIRECTION:CAPS"></a><h3>SOUP_STATUS_IS_REDIRECTION()</h3>
135 <pre class="programlisting">#define SOUP_STATUS_IS_REDIRECTION(status)     ((status) &gt;= 300 &amp;&amp; (status) &lt; 400)
136 </pre>
137 <p>
138 Tests if <em class="parameter"><code>status</code></em> is a Redirection (3xx) response.
139 </p>
140 <div class="variablelist"><table border="0">
141 <col align="left" valign="top">
142 <tbody>
143 <tr>
144 <td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
145 <td>an HTTP status code</td>
146 </tr>
147 <tr>
148 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
149 <td>
150 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
151 </td>
152 </tr>
153 </tbody>
154 </table></div>
155 </div>
156 <hr>
157 <div class="refsect2">
158 <a name="SOUP-STATUS-IS-CLIENT-ERROR:CAPS"></a><h3>SOUP_STATUS_IS_CLIENT_ERROR()</h3>
159 <pre class="programlisting">#define SOUP_STATUS_IS_CLIENT_ERROR(status)    ((status) &gt;= 400 &amp;&amp; (status) &lt; 500)
160 </pre>
161 <p>
162 Tests if <em class="parameter"><code>status</code></em> is a Client Error (4xx) response.
163 </p>
164 <div class="variablelist"><table border="0">
165 <col align="left" valign="top">
166 <tbody>
167 <tr>
168 <td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
169 <td>an HTTP status code</td>
170 </tr>
171 <tr>
172 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
173 <td>
174 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
175 </td>
176 </tr>
177 </tbody>
178 </table></div>
179 </div>
180 <hr>
181 <div class="refsect2">
182 <a name="SOUP-STATUS-IS-SERVER-ERROR:CAPS"></a><h3>SOUP_STATUS_IS_SERVER_ERROR()</h3>
183 <pre class="programlisting">#define SOUP_STATUS_IS_SERVER_ERROR(status)    ((status) &gt;= 500 &amp;&amp; (status) &lt; 600)
184 </pre>
185 <p>
186 Tests if <em class="parameter"><code>status</code></em> is a Server Error (5xx) response.
187 </p>
188 <div class="variablelist"><table border="0">
189 <col align="left" valign="top">
190 <tbody>
191 <tr>
192 <td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
193 <td>an HTTP status code</td>
194 </tr>
195 <tr>
196 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
197 <td>
198 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
199 </td>
200 </tr>
201 </tbody>
202 </table></div>
203 </div>
204 <hr>
205 <div class="refsect2">
206 <a name="SoupKnownStatusCode"></a><h3>enum SoupKnownStatusCode</h3>
207 <pre class="programlisting">typedef enum {
208         SOUP_STATUS_NONE,
209
210         /* Transport Errors */
211         SOUP_STATUS_CANCELLED                       = 1,
212         SOUP_STATUS_CANT_RESOLVE,
213         SOUP_STATUS_CANT_RESOLVE_PROXY,
214         SOUP_STATUS_CANT_CONNECT,
215         SOUP_STATUS_CANT_CONNECT_PROXY,
216         SOUP_STATUS_SSL_FAILED,
217         SOUP_STATUS_IO_ERROR,
218         SOUP_STATUS_MALFORMED,
219         SOUP_STATUS_TRY_AGAIN,
220         SOUP_STATUS_TOO_MANY_REDIRECTS,
221         SOUP_STATUS_TLS_FAILED,
222
223         /* HTTP Status Codes */
224         SOUP_STATUS_CONTINUE                        = 100,
225         SOUP_STATUS_SWITCHING_PROTOCOLS             = 101,
226         SOUP_STATUS_PROCESSING                      = 102, /* WebDAV */
227
228         SOUP_STATUS_OK                              = 200,
229         SOUP_STATUS_CREATED                         = 201,
230         SOUP_STATUS_ACCEPTED                        = 202,
231         SOUP_STATUS_NON_AUTHORITATIVE               = 203,
232         SOUP_STATUS_NO_CONTENT                      = 204,
233         SOUP_STATUS_RESET_CONTENT                   = 205,
234         SOUP_STATUS_PARTIAL_CONTENT                 = 206,
235         SOUP_STATUS_MULTI_STATUS                    = 207, /* WebDAV */
236
237         SOUP_STATUS_MULTIPLE_CHOICES                = 300,
238         SOUP_STATUS_MOVED_PERMANENTLY               = 301,
239         SOUP_STATUS_FOUND                           = 302,
240         SOUP_STATUS_MOVED_TEMPORARILY               = 302, /* RFC 2068 */
241         SOUP_STATUS_SEE_OTHER                       = 303,
242         SOUP_STATUS_NOT_MODIFIED                    = 304,
243         SOUP_STATUS_USE_PROXY                       = 305,
244         SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL  = 306, /* (reserved) */
245         SOUP_STATUS_TEMPORARY_REDIRECT              = 307,
246
247         SOUP_STATUS_BAD_REQUEST                     = 400,
248         SOUP_STATUS_UNAUTHORIZED                    = 401,
249         SOUP_STATUS_PAYMENT_REQUIRED                = 402, /* (reserved) */
250         SOUP_STATUS_FORBIDDEN                       = 403,
251         SOUP_STATUS_NOT_FOUND                       = 404,
252         SOUP_STATUS_METHOD_NOT_ALLOWED              = 405,
253         SOUP_STATUS_NOT_ACCEPTABLE                  = 406,
254         SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED   = 407,
255         SOUP_STATUS_PROXY_UNAUTHORIZED              = SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED,
256         SOUP_STATUS_REQUEST_TIMEOUT                 = 408,
257         SOUP_STATUS_CONFLICT                        = 409,
258         SOUP_STATUS_GONE                            = 410,
259         SOUP_STATUS_LENGTH_REQUIRED                 = 411,
260         SOUP_STATUS_PRECONDITION_FAILED             = 412,
261         SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE        = 413,
262         SOUP_STATUS_REQUEST_URI_TOO_LONG            = 414,
263         SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE          = 415,
264         SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE = 416,
265         SOUP_STATUS_INVALID_RANGE                   = SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE,
266         SOUP_STATUS_EXPECTATION_FAILED              = 417,
267         SOUP_STATUS_UNPROCESSABLE_ENTITY            = 422, /* WebDAV */
268         SOUP_STATUS_LOCKED                          = 423, /* WebDAV */
269         SOUP_STATUS_FAILED_DEPENDENCY               = 424, /* WebDAV */
270
271         SOUP_STATUS_INTERNAL_SERVER_ERROR           = 500,
272         SOUP_STATUS_NOT_IMPLEMENTED                 = 501,
273         SOUP_STATUS_BAD_GATEWAY                     = 502,
274         SOUP_STATUS_SERVICE_UNAVAILABLE             = 503,
275         SOUP_STATUS_GATEWAY_TIMEOUT                 = 504,
276         SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED      = 505,
277         SOUP_STATUS_INSUFFICIENT_STORAGE            = 507, /* WebDAV search */
278         SOUP_STATUS_NOT_EXTENDED                    = 510  /* RFC 2774 */
279 } SoupKnownStatusCode;
280 </pre>
281 <p>
282 These represent the known HTTP status code values, plus various
283 network and internal errors.
284 </p>
285 <div class="variablelist"><table border="0">
286 <col align="left" valign="top">
287 <tbody>
288 <tr>
289 <td><p><a name="SOUP-STATUS-NONE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_NONE</code></span></p></td>
290 <td>No status available. (Eg, the message has not
291 been sent yet)
292 </td>
293 </tr>
294 <tr>
295 <td><p><a name="SOUP-STATUS-CANCELLED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_CANCELLED</code></span></p></td>
296 <td>Message was cancelled locally
297 </td>
298 </tr>
299 <tr>
300 <td><p><a name="SOUP-STATUS-CANT-RESOLVE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_CANT_RESOLVE</code></span></p></td>
301 <td>Unable to resolve destination host name
302 </td>
303 </tr>
304 <tr>
305 <td><p><a name="SOUP-STATUS-CANT-RESOLVE-PROXY:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_CANT_RESOLVE_PROXY</code></span></p></td>
306 <td>Unable to resolve proxy host name
307 </td>
308 </tr>
309 <tr>
310 <td><p><a name="SOUP-STATUS-CANT-CONNECT:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_CANT_CONNECT</code></span></p></td>
311 <td>Unable to connect to remote host
312 </td>
313 </tr>
314 <tr>
315 <td><p><a name="SOUP-STATUS-CANT-CONNECT-PROXY:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_CANT_CONNECT_PROXY</code></span></p></td>
316 <td>Unable to connect to proxy
317 </td>
318 </tr>
319 <tr>
320 <td><p><a name="SOUP-STATUS-SSL-FAILED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_SSL_FAILED</code></span></p></td>
321 <td>SSL/TLS negotiation failed
322 </td>
323 </tr>
324 <tr>
325 <td><p><a name="SOUP-STATUS-IO-ERROR:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_IO_ERROR</code></span></p></td>
326 <td>A network error occurred, or the other end
327 closed the connection unexpectedly
328 </td>
329 </tr>
330 <tr>
331 <td><p><a name="SOUP-STATUS-MALFORMED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_MALFORMED</code></span></p></td>
332 <td>Malformed data (usually a programmer error)
333 </td>
334 </tr>
335 <tr>
336 <td><p><a name="SOUP-STATUS-TRY-AGAIN:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_TRY_AGAIN</code></span></p></td>
337 <td>Used internally
338 </td>
339 </tr>
340 <tr>
341 <td><p><a name="SOUP-STATUS-TOO-MANY-REDIRECTS:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_TOO_MANY_REDIRECTS</code></span></p></td>
342 <td>There were too many redirections
343 </td>
344 </tr>
345 <tr>
346 <td><p><a name="SOUP-STATUS-TLS-FAILED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_TLS_FAILED</code></span></p></td>
347 <td>Used internally
348 </td>
349 </tr>
350 <tr>
351 <td><p><a name="SOUP-STATUS-CONTINUE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_CONTINUE</code></span></p></td>
352 <td>100 Continue (HTTP)
353 </td>
354 </tr>
355 <tr>
356 <td><p><a name="SOUP-STATUS-SWITCHING-PROTOCOLS:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_SWITCHING_PROTOCOLS</code></span></p></td>
357 <td>101 Switching Protocols (HTTP)
358 </td>
359 </tr>
360 <tr>
361 <td><p><a name="SOUP-STATUS-PROCESSING:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_PROCESSING</code></span></p></td>
362 <td>102 Processing (WebDAV)
363 </td>
364 </tr>
365 <tr>
366 <td><p><a name="SOUP-STATUS-OK:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_OK</code></span></p></td>
367 <td>200 Success (HTTP). Also used by many lower-level
368 soup routines to indicate success.
369 </td>
370 </tr>
371 <tr>
372 <td><p><a name="SOUP-STATUS-CREATED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_CREATED</code></span></p></td>
373 <td>201 Created (HTTP)
374 </td>
375 </tr>
376 <tr>
377 <td><p><a name="SOUP-STATUS-ACCEPTED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_ACCEPTED</code></span></p></td>
378 <td>202 Accepted (HTTP)
379 </td>
380 </tr>
381 <tr>
382 <td><p><a name="SOUP-STATUS-NON-AUTHORITATIVE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_NON_AUTHORITATIVE</code></span></p></td>
383 <td>203 Non-Authoritative Information
384 (HTTP)
385 </td>
386 </tr>
387 <tr>
388 <td><p><a name="SOUP-STATUS-NO-CONTENT:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_NO_CONTENT</code></span></p></td>
389 <td>204 No Content (HTTP)
390 </td>
391 </tr>
392 <tr>
393 <td><p><a name="SOUP-STATUS-RESET-CONTENT:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_RESET_CONTENT</code></span></p></td>
394 <td>205 Reset Content (HTTP)
395 </td>
396 </tr>
397 <tr>
398 <td><p><a name="SOUP-STATUS-PARTIAL-CONTENT:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_PARTIAL_CONTENT</code></span></p></td>
399 <td>206 Partial Content (HTTP)
400 </td>
401 </tr>
402 <tr>
403 <td><p><a name="SOUP-STATUS-MULTI-STATUS:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_MULTI_STATUS</code></span></p></td>
404 <td>207 Multi-Status (WebDAV)
405 </td>
406 </tr>
407 <tr>
408 <td><p><a name="SOUP-STATUS-MULTIPLE-CHOICES:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_MULTIPLE_CHOICES</code></span></p></td>
409 <td>300 Multiple Choices (HTTP)
410 </td>
411 </tr>
412 <tr>
413 <td><p><a name="SOUP-STATUS-MOVED-PERMANENTLY:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_MOVED_PERMANENTLY</code></span></p></td>
414 <td>301 Moved Permanently (HTTP)
415 </td>
416 </tr>
417 <tr>
418 <td><p><a name="SOUP-STATUS-FOUND:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_FOUND</code></span></p></td>
419 <td>302 Found (HTTP)
420 </td>
421 </tr>
422 <tr>
423 <td><p><a name="SOUP-STATUS-MOVED-TEMPORARILY:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_MOVED_TEMPORARILY</code></span></p></td>
424 <td>302 Moved Temporarily (old name,
425 RFC 2068)
426 </td>
427 </tr>
428 <tr>
429 <td><p><a name="SOUP-STATUS-SEE-OTHER:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_SEE_OTHER</code></span></p></td>
430 <td>303 See Other (HTTP)
431 </td>
432 </tr>
433 <tr>
434 <td><p><a name="SOUP-STATUS-NOT-MODIFIED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_NOT_MODIFIED</code></span></p></td>
435 <td>304 Not Modified (HTTP)
436 </td>
437 </tr>
438 <tr>
439 <td><p><a name="SOUP-STATUS-USE-PROXY:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_USE_PROXY</code></span></p></td>
440 <td>305 Use Proxy (HTTP)
441 </td>
442 </tr>
443 <tr>
444 <td><p><a name="SOUP-STATUS-NOT-APPEARING-IN-THIS-PROTOCOL:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL</code></span></p></td>
445 <td>306 [Unused] (HTTP)
446 </td>
447 </tr>
448 <tr>
449 <td><p><a name="SOUP-STATUS-TEMPORARY-REDIRECT:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_TEMPORARY_REDIRECT</code></span></p></td>
450 <td>307 Temporary Redirect (HTTP)
451 </td>
452 </tr>
453 <tr>
454 <td><p><a name="SOUP-STATUS-BAD-REQUEST:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_BAD_REQUEST</code></span></p></td>
455 <td>400 Bad Request (HTTP)
456 </td>
457 </tr>
458 <tr>
459 <td><p><a name="SOUP-STATUS-UNAUTHORIZED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_UNAUTHORIZED</code></span></p></td>
460 <td>401 Unauthorized (HTTP)
461 </td>
462 </tr>
463 <tr>
464 <td><p><a name="SOUP-STATUS-PAYMENT-REQUIRED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_PAYMENT_REQUIRED</code></span></p></td>
465 <td>402 Payment Required (HTTP)
466 </td>
467 </tr>
468 <tr>
469 <td><p><a name="SOUP-STATUS-FORBIDDEN:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_FORBIDDEN</code></span></p></td>
470 <td>403 Forbidden (HTTP)
471 </td>
472 </tr>
473 <tr>
474 <td><p><a name="SOUP-STATUS-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_NOT_FOUND</code></span></p></td>
475 <td>404 Not Found (HTTP)
476 </td>
477 </tr>
478 <tr>
479 <td><p><a name="SOUP-STATUS-METHOD-NOT-ALLOWED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_METHOD_NOT_ALLOWED</code></span></p></td>
480 <td>405 Method Not Allowed (HTTP)
481 </td>
482 </tr>
483 <tr>
484 <td><p><a name="SOUP-STATUS-NOT-ACCEPTABLE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_NOT_ACCEPTABLE</code></span></p></td>
485 <td>406 Not Acceptable (HTTP)
486 </td>
487 </tr>
488 <tr>
489 <td><p><a name="SOUP-STATUS-PROXY-AUTHENTICATION-REQUIRED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED</code></span></p></td>
490 <td>407 Proxy Authentication
491 Required (HTTP)
492 </td>
493 </tr>
494 <tr>
495 <td><p><a name="SOUP-STATUS-PROXY-UNAUTHORIZED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_PROXY_UNAUTHORIZED</code></span></p></td>
496 <td>shorter alias for
497 <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-PROXY-AUTHENTICATION-REQUIRED:CAPS"><code class="literal">SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED</code></a>
498 </td>
499 </tr>
500 <tr>
501 <td><p><a name="SOUP-STATUS-REQUEST-TIMEOUT:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_REQUEST_TIMEOUT</code></span></p></td>
502 <td>408 Request Timeout (HTTP)
503 </td>
504 </tr>
505 <tr>
506 <td><p><a name="SOUP-STATUS-CONFLICT:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_CONFLICT</code></span></p></td>
507 <td>409 Conflict (HTTP)
508 </td>
509 </tr>
510 <tr>
511 <td><p><a name="SOUP-STATUS-GONE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_GONE</code></span></p></td>
512 <td>410 Gone (HTTP)
513 </td>
514 </tr>
515 <tr>
516 <td><p><a name="SOUP-STATUS-LENGTH-REQUIRED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_LENGTH_REQUIRED</code></span></p></td>
517 <td>411 Length Required (HTTP)
518 </td>
519 </tr>
520 <tr>
521 <td><p><a name="SOUP-STATUS-PRECONDITION-FAILED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_PRECONDITION_FAILED</code></span></p></td>
522 <td>412 Precondition Failed (HTTP)
523 </td>
524 </tr>
525 <tr>
526 <td><p><a name="SOUP-STATUS-REQUEST-ENTITY-TOO-LARGE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE</code></span></p></td>
527 <td>413 Request Entity Too Large
528 (HTTP)
529 </td>
530 </tr>
531 <tr>
532 <td><p><a name="SOUP-STATUS-REQUEST-URI-TOO-LONG:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_REQUEST_URI_TOO_LONG</code></span></p></td>
533 <td>414 Request-URI Too Long (HTTP)
534 </td>
535 </tr>
536 <tr>
537 <td><p><a name="SOUP-STATUS-UNSUPPORTED-MEDIA-TYPE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE</code></span></p></td>
538 <td>415 Unsupported Media Type
539 (HTTP)
540 </td>
541 </tr>
542 <tr>
543 <td><p><a name="SOUP-STATUS-REQUESTED-RANGE-NOT-SATISFIABLE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE</code></span></p></td>
544 <td>416 Requested Range
545 Not Satisfiable (HTTP)
546 </td>
547 </tr>
548 <tr>
549 <td><p><a name="SOUP-STATUS-INVALID-RANGE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_INVALID_RANGE</code></span></p></td>
550 <td>shorter alias for
551 <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-REQUESTED-RANGE-NOT-SATISFIABLE:CAPS"><code class="literal">SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE</code></a>
552 </td>
553 </tr>
554 <tr>
555 <td><p><a name="SOUP-STATUS-EXPECTATION-FAILED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_EXPECTATION_FAILED</code></span></p></td>
556 <td>417 Expectation Failed (HTTP)
557 </td>
558 </tr>
559 <tr>
560 <td><p><a name="SOUP-STATUS-UNPROCESSABLE-ENTITY:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_UNPROCESSABLE_ENTITY</code></span></p></td>
561 <td>422 Unprocessable Entity
562 (WebDAV)
563 </td>
564 </tr>
565 <tr>
566 <td><p><a name="SOUP-STATUS-LOCKED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_LOCKED</code></span></p></td>
567 <td>423 Locked (WebDAV)
568 </td>
569 </tr>
570 <tr>
571 <td><p><a name="SOUP-STATUS-FAILED-DEPENDENCY:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_FAILED_DEPENDENCY</code></span></p></td>
572 <td>424 Failed Dependency (WebDAV)
573 </td>
574 </tr>
575 <tr>
576 <td><p><a name="SOUP-STATUS-INTERNAL-SERVER-ERROR:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_INTERNAL_SERVER_ERROR</code></span></p></td>
577 <td>500 Internal Server Error
578 (HTTP)
579 </td>
580 </tr>
581 <tr>
582 <td><p><a name="SOUP-STATUS-NOT-IMPLEMENTED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_NOT_IMPLEMENTED</code></span></p></td>
583 <td>501 Not Implemented (HTTP)
584 </td>
585 </tr>
586 <tr>
587 <td><p><a name="SOUP-STATUS-BAD-GATEWAY:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_BAD_GATEWAY</code></span></p></td>
588 <td>502 Bad Gateway (HTTP)
589 </td>
590 </tr>
591 <tr>
592 <td><p><a name="SOUP-STATUS-SERVICE-UNAVAILABLE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_SERVICE_UNAVAILABLE</code></span></p></td>
593 <td>503 Service Unavailable (HTTP)
594 </td>
595 </tr>
596 <tr>
597 <td><p><a name="SOUP-STATUS-GATEWAY-TIMEOUT:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_GATEWAY_TIMEOUT</code></span></p></td>
598 <td>504 Gateway Timeout (HTTP)
599 </td>
600 </tr>
601 <tr>
602 <td><p><a name="SOUP-STATUS-HTTP-VERSION-NOT-SUPPORTED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED</code></span></p></td>
603 <td>505 HTTP Version Not
604 Supported (HTTP)
605 </td>
606 </tr>
607 <tr>
608 <td><p><a name="SOUP-STATUS-INSUFFICIENT-STORAGE:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_INSUFFICIENT_STORAGE</code></span></p></td>
609 <td>507 Insufficient Storage
610 (WebDAV)
611 </td>
612 </tr>
613 <tr>
614 <td><p><a name="SOUP-STATUS-NOT-EXTENDED:CAPS"></a><span class="term"><code class="literal">SOUP_STATUS_NOT_EXTENDED</code></span></p></td>
615 <td>510 Not Extended (RFC 2774)
616 </td>
617 </tr>
618 </tbody>
619 </table></div>
620 </div>
621 <hr>
622 <div class="refsect2">
623 <a name="soup-status-get-phrase"></a><h3>soup_status_get_phrase ()</h3>
624 <pre class="programlisting">const <span class="returnvalue">char</span> *        soup_status_get_phrase              (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> status_code</code></em>);</pre>
625 <p>
626 Looks up the stock HTTP description of <em class="parameter"><code>status_code</code></em>. This is used
627 by <a class="link" href="SoupMessage.html#soup-message-set-status" title="soup_message_set_status ()"><code class="function">soup_message_set_status()</code></a> to get the correct text to go with a
628 given status code.
629 </p>
630 <p>
631 <span class="emphasis"><em>There is no reason for you to ever use this
632 function.</em></span> If you wanted the textual description for the
633 <a class="link" href="SoupMessage.html#SoupMessage--status-code" title='The "status-code" property'><span class="type">"status_code"</span></a> of a given <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, you should just
634 look at the message's <a class="link" href="SoupMessage.html#SoupMessage--reason-phrase" title='The "reason-phrase" property'><span class="type">"reason_phrase"</span></a>. However, you
635 should only do that for use in debugging messages; HTTP reason
636 phrases are not localized, and are not generally very descriptive
637 anyway, and so they should never be presented to the user directly.
638 Instead, you should create you own error messages based on the
639 status code, and on what you were trying to do.
640 </p>
641 <div class="variablelist"><table border="0">
642 <col align="left" valign="top">
643 <tbody>
644 <tr>
645 <td><p><span class="term"><em class="parameter"><code>status_code</code></em> :</span></p></td>
646 <td>an HTTP status code</td>
647 </tr>
648 <tr>
649 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
650 <td>the (terse, English) description of <em class="parameter"><code>status_code</code></em>
651 </td>
652 </tr>
653 </tbody>
654 </table></div>
655 </div>
656 <hr>
657 <div class="refsect2">
658 <a name="soup-status-proxify"></a><h3>soup_status_proxify ()</h3>
659 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               soup_status_proxify                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> status_code</code></em>);</pre>
660 <p>
661 Turns <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-RESOLVE:CAPS"><code class="literal">SOUP_STATUS_CANT_RESOLVE</code></a> into
662 <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-RESOLVE-PROXY:CAPS"><code class="literal">SOUP_STATUS_CANT_RESOLVE_PROXY</code></a> and <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-CONNECT:CAPS"><code class="literal">SOUP_STATUS_CANT_CONNECT</code></a> into
663 <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-CONNECT-PROXY:CAPS"><code class="literal">SOUP_STATUS_CANT_CONNECT_PROXY</code></a>. Other status codes are passed
664 through unchanged.
665 </p>
666 <div class="variablelist"><table border="0">
667 <col align="left" valign="top">
668 <tbody>
669 <tr>
670 <td><p><span class="term"><em class="parameter"><code>status_code</code></em> :</span></p></td>
671 <td>a status code</td>
672 </tr>
673 <tr>
674 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
675 <td>the "proxified" equivalent of <em class="parameter"><code>status_code</code></em>.</td>
676 </tr>
677 </tbody>
678 </table></div>
679 <p class="since">Since 2.26</p>
680 </div>
681 <hr>
682 <div class="refsect2">
683 <a name="SOUP-HTTP-ERROR:CAPS"></a><h3>SOUP_HTTP_ERROR</h3>
684 <pre class="programlisting">#define SOUP_HTTP_ERROR soup_http_error_quark()
685 </pre>
686 <p>
687 A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> domain representing an HTTP status. Use a
688 <a class="link" href="libsoup-2.4-soup-status.html#SoupKnownStatusCode" title="enum SoupKnownStatusCode"><span class="type">SoupKnownStatusCode</span></a> for the <em class="structfield"><code>code</code></em>
689 value.
690 </p>
691 </div>
692 </div>
693 </div>
694 <div class="footer">
695 <hr>
696           Generated by GTK-Doc V1.18</div>
697 </body>
698 </html>