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 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libsoup-soup-status">
<refmeta>
<refentrytitle role="top_of_page">soup-status</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBSOUP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>soup-status</refname>
<refpurpose>HTTP and Soup status codes</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="SoupStatusClass">SoupStatusClass</link>;
#define <link linkend="SOUP-STATUS-IS-INFORMATIONAL:CAPS">SOUP_STATUS_IS_INFORMATIONAL</link> (status)
#define <link linkend="SOUP-STATUS-IS-SUCCESSFUL:CAPS">SOUP_STATUS_IS_SUCCESSFUL</link> (status)
#define <link linkend="SOUP-STATUS-IS-REDIRECTION:CAPS">SOUP_STATUS_IS_REDIRECTION</link> (status)
#define <link linkend="SOUP-STATUS-IS-CLIENT-ERROR:CAPS">SOUP_STATUS_IS_CLIENT_ERROR</link> (status)
#define <link linkend="SOUP-STATUS-IS-SERVER-ERROR:CAPS">SOUP_STATUS_IS_SERVER_ERROR</link> (status)
enum <link linkend="SoupKnownStatusCode">SoupKnownStatusCode</link>;
const <link linkend="char">char</link>* <link linkend="soup-status-get-phrase">soup_status_get_phrase</link> (<link linkend="guint">guint</link> status_code);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SoupStatusClass" role="enum"/>enum SoupStatusClass</title>
<indexterm><primary>SoupStatusClass</primary></indexterm><programlisting>typedef enum {
SOUP_STATUS_CLASS_TRANSPORT_ERROR = 0,
SOUP_STATUS_CLASS_INFORMATIONAL,
SOUP_STATUS_CLASS_SUCCESS,
SOUP_STATUS_CLASS_REDIRECT,
SOUP_STATUS_CLASS_CLIENT_ERROR,
SOUP_STATUS_CLASS_SERVER_ERROR
} SoupStatusClass;
</programlisting>
<para>
The classes of HTTP and Soup status codes</para>
<para>
</para><variablelist role="enum">
<varlistentry>
<term><anchor id="SOUP-STATUS-CLASS-TRANSPORT-ERROR:CAPS" role="constant"/><literal>SOUP_STATUS_CLASS_TRANSPORT_ERROR</literal></term>
<listitem><simpara> Network or Soup-level error
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CLASS-INFORMATIONAL:CAPS" role="constant"/><literal>SOUP_STATUS_CLASS_INFORMATIONAL</literal></term>
<listitem><simpara> HTTP 1xx response providing
partial information about the state of a request
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CLASS-SUCCESS:CAPS" role="constant"/><literal>SOUP_STATUS_CLASS_SUCCESS</literal></term>
<listitem><simpara> HTTP 2xx successful response
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CLASS-REDIRECT:CAPS" role="constant"/><literal>SOUP_STATUS_CLASS_REDIRECT</literal></term>
<listitem><simpara> HTTP 3xx redirection response
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CLASS-CLIENT-ERROR:CAPS" role="constant"/><literal>SOUP_STATUS_CLASS_CLIENT_ERROR</literal></term>
<listitem><simpara> HTTP 4xx client error response
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CLASS-SERVER-ERROR:CAPS" role="constant"/><literal>SOUP_STATUS_CLASS_SERVER_ERROR</literal></term>
<listitem><simpara> HTTP 5xx server error response
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SOUP-STATUS-IS-INFORMATIONAL:CAPS" role="macro"/>SOUP_STATUS_IS_INFORMATIONAL()</title>
<indexterm><primary>SOUP_STATUS_IS_INFORMATIONAL</primary></indexterm><programlisting>#define SOUP_STATUS_IS_INFORMATIONAL(status) ((status) >= 100 && (status) < 200)
</programlisting>
<para>
Tests if <parameter>status</parameter> is an Informational (1xx) response.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> an HTTP status code
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SOUP-STATUS-IS-SUCCESSFUL:CAPS" role="macro"/>SOUP_STATUS_IS_SUCCESSFUL()</title>
<indexterm><primary>SOUP_STATUS_IS_SUCCESSFUL</primary></indexterm><programlisting>#define SOUP_STATUS_IS_SUCCESSFUL(status) ((status) >= 200 && (status) < 300)
</programlisting>
<para>
Tests if <parameter>status</parameter> is a Successful (2xx) response.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> an HTTP status code
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SOUP-STATUS-IS-REDIRECTION:CAPS" role="macro"/>SOUP_STATUS_IS_REDIRECTION()</title>
<indexterm><primary>SOUP_STATUS_IS_REDIRECTION</primary></indexterm><programlisting>#define SOUP_STATUS_IS_REDIRECTION(status) ((status) >= 300 && (status) < 400)
</programlisting>
<para>
Tests if <parameter>status</parameter> is a Redirection (3xx) response.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> an HTTP status code
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SOUP-STATUS-IS-CLIENT-ERROR:CAPS" role="macro"/>SOUP_STATUS_IS_CLIENT_ERROR()</title>
<indexterm><primary>SOUP_STATUS_IS_CLIENT_ERROR</primary></indexterm><programlisting>#define SOUP_STATUS_IS_CLIENT_ERROR(status) ((status) >= 400 && (status) < 500)
</programlisting>
<para>
Tests if <parameter>status</parameter> is a Client Error (4xx) response.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> an HTTP status code
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SOUP-STATUS-IS-SERVER-ERROR:CAPS" role="macro"/>SOUP_STATUS_IS_SERVER_ERROR()</title>
<indexterm><primary>SOUP_STATUS_IS_SERVER_ERROR</primary></indexterm><programlisting>#define SOUP_STATUS_IS_SERVER_ERROR(status) ((status) >= 500 && (status) < 600)
</programlisting>
<para>
Tests if <parameter>status</parameter> is a Server Error (5xx) response.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> an HTTP status code
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SoupKnownStatusCode" role="enum"/>enum SoupKnownStatusCode</title>
<indexterm><primary>SoupKnownStatusCode</primary></indexterm><programlisting>typedef enum {
SOUP_STATUS_NONE,
/* Transport Errors */
SOUP_STATUS_CANCELLED = 1,
SOUP_STATUS_CANT_RESOLVE,
SOUP_STATUS_CANT_RESOLVE_PROXY,
SOUP_STATUS_CANT_CONNECT,
SOUP_STATUS_CANT_CONNECT_PROXY,
SOUP_STATUS_SSL_FAILED,
SOUP_STATUS_IO_ERROR,
SOUP_STATUS_MALFORMED,
SOUP_STATUS_TRY_AGAIN,
/* HTTP Status Codes */
SOUP_STATUS_CONTINUE = 100,
SOUP_STATUS_SWITCHING_PROTOCOLS = 101,
SOUP_STATUS_PROCESSING = 102, /* WebDAV */
SOUP_STATUS_OK = 200,
SOUP_STATUS_CREATED = 201,
SOUP_STATUS_ACCEPTED = 202,
SOUP_STATUS_NON_AUTHORITATIVE = 203,
SOUP_STATUS_NO_CONTENT = 204,
SOUP_STATUS_RESET_CONTENT = 205,
SOUP_STATUS_PARTIAL_CONTENT = 206,
SOUP_STATUS_MULTI_STATUS = 207, /* WebDAV */
SOUP_STATUS_MULTIPLE_CHOICES = 300,
SOUP_STATUS_MOVED_PERMANENTLY = 301,
SOUP_STATUS_FOUND = 302,
SOUP_STATUS_MOVED_TEMPORARILY = 302, /* RFC 2068 */
SOUP_STATUS_SEE_OTHER = 303,
SOUP_STATUS_NOT_MODIFIED = 304,
SOUP_STATUS_USE_PROXY = 305,
SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL = 306, /* (reserved) */
SOUP_STATUS_TEMPORARY_REDIRECT = 307,
SOUP_STATUS_BAD_REQUEST = 400,
SOUP_STATUS_UNAUTHORIZED = 401,
SOUP_STATUS_PAYMENT_REQUIRED = 402, /* (reserved) */
SOUP_STATUS_FORBIDDEN = 403,
SOUP_STATUS_NOT_FOUND = 404,
SOUP_STATUS_METHOD_NOT_ALLOWED = 405,
SOUP_STATUS_NOT_ACCEPTABLE = 406,
SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED = 407,
SOUP_STATUS_PROXY_UNAUTHORIZED = SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED,
SOUP_STATUS_REQUEST_TIMEOUT = 408,
SOUP_STATUS_CONFLICT = 409,
SOUP_STATUS_GONE = 410,
SOUP_STATUS_LENGTH_REQUIRED = 411,
SOUP_STATUS_PRECONDITION_FAILED = 412,
SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE = 413,
SOUP_STATUS_REQUEST_URI_TOO_LONG = 414,
SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE = 415,
SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE = 416,
SOUP_STATUS_INVALID_RANGE = SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE,
SOUP_STATUS_EXPECTATION_FAILED = 417,
SOUP_STATUS_UNPROCESSABLE_ENTITY = 422, /* WebDAV */
SOUP_STATUS_LOCKED = 423, /* WebDAV */
SOUP_STATUS_FAILED_DEPENDENCY = 424, /* WebDAV */
SOUP_STATUS_INTERNAL_SERVER_ERROR = 500,
SOUP_STATUS_NOT_IMPLEMENTED = 501,
SOUP_STATUS_BAD_GATEWAY = 502,
SOUP_STATUS_SERVICE_UNAVAILABLE = 503,
SOUP_STATUS_GATEWAY_TIMEOUT = 504,
SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED = 505,
SOUP_STATUS_INSUFFICIENT_STORAGE = 507, /* WebDAV search */
SOUP_STATUS_NOT_EXTENDED = 510 /* RFC 2774 */
} SoupKnownStatusCode;
</programlisting>
<para>
These represent the known HTTP status code values, plus various
network and internal errors.</para>
<para>
</para><variablelist role="enum">
<varlistentry>
<term><anchor id="SOUP-STATUS-NONE:CAPS" role="constant"/><literal>SOUP_STATUS_NONE</literal></term>
<listitem><simpara> No status available. (Eg, the message has not
been sent yet)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CANCELLED:CAPS" role="constant"/><literal>SOUP_STATUS_CANCELLED</literal></term>
<listitem><simpara> Message was cancelled locally
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CANT-RESOLVE:CAPS" role="constant"/><literal>SOUP_STATUS_CANT_RESOLVE</literal></term>
<listitem><simpara> Unable to resolve destination host name
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CANT-RESOLVE-PROXY:CAPS" role="constant"/><literal>SOUP_STATUS_CANT_RESOLVE_PROXY</literal></term>
<listitem><simpara> Unable to resolve proxy host name
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CANT-CONNECT:CAPS" role="constant"/><literal>SOUP_STATUS_CANT_CONNECT</literal></term>
<listitem><simpara> Unable to connect to remote host
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CANT-CONNECT-PROXY:CAPS" role="constant"/><literal>SOUP_STATUS_CANT_CONNECT_PROXY</literal></term>
<listitem><simpara> Unable to connect to proxy
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-SSL-FAILED:CAPS" role="constant"/><literal>SOUP_STATUS_SSL_FAILED</literal></term>
<listitem><simpara> SSL negotiation failed
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-IO-ERROR:CAPS" role="constant"/><literal>SOUP_STATUS_IO_ERROR</literal></term>
<listitem><simpara> A network error occurred, or the other end
closed the connection unexpectedly
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-MALFORMED:CAPS" role="constant"/><literal>SOUP_STATUS_MALFORMED</literal></term>
<listitem><simpara> Malformed data (usually a programmer error)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-TRY-AGAIN:CAPS" role="constant"/><literal>SOUP_STATUS_TRY_AGAIN</literal></term>
<listitem><simpara> Try again. (Only returned in certain
specifically documented cases)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CONTINUE:CAPS" role="constant"/><literal>SOUP_STATUS_CONTINUE</literal></term>
<listitem><simpara> 100 Continue (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-SWITCHING-PROTOCOLS:CAPS" role="constant"/><literal>SOUP_STATUS_SWITCHING_PROTOCOLS</literal></term>
<listitem><simpara> 101 Switching Protocols (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-PROCESSING:CAPS" role="constant"/><literal>SOUP_STATUS_PROCESSING</literal></term>
<listitem><simpara> 102 Processing (WebDAV)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-OK:CAPS" role="constant"/><literal>SOUP_STATUS_OK</literal></term>
<listitem><simpara> 200 Success (HTTP). Also used by many lower-level
soup routines to indicate success.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CREATED:CAPS" role="constant"/><literal>SOUP_STATUS_CREATED</literal></term>
<listitem><simpara> 201 Created (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-ACCEPTED:CAPS" role="constant"/><literal>SOUP_STATUS_ACCEPTED</literal></term>
<listitem><simpara> 202 Accepted (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-NON-AUTHORITATIVE:CAPS" role="constant"/><literal>SOUP_STATUS_NON_AUTHORITATIVE</literal></term>
<listitem><simpara> 203 Non-Authoritative Information
(HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-NO-CONTENT:CAPS" role="constant"/><literal>SOUP_STATUS_NO_CONTENT</literal></term>
<listitem><simpara> 204 No Content (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-RESET-CONTENT:CAPS" role="constant"/><literal>SOUP_STATUS_RESET_CONTENT</literal></term>
<listitem><simpara> 205 Reset Content (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-PARTIAL-CONTENT:CAPS" role="constant"/><literal>SOUP_STATUS_PARTIAL_CONTENT</literal></term>
<listitem><simpara> 206 Partial Content (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-MULTI-STATUS:CAPS" role="constant"/><literal>SOUP_STATUS_MULTI_STATUS</literal></term>
<listitem><simpara> 207 Multi-Status (WebDAV)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-MULTIPLE-CHOICES:CAPS" role="constant"/><literal>SOUP_STATUS_MULTIPLE_CHOICES</literal></term>
<listitem><simpara> 300 Multiple Choices (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-MOVED-PERMANENTLY:CAPS" role="constant"/><literal>SOUP_STATUS_MOVED_PERMANENTLY</literal></term>
<listitem><simpara> 301 Moved Permanently (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-FOUND:CAPS" role="constant"/><literal>SOUP_STATUS_FOUND</literal></term>
<listitem><simpara> 302 Found (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-MOVED-TEMPORARILY:CAPS" role="constant"/><literal>SOUP_STATUS_MOVED_TEMPORARILY</literal></term>
<listitem><simpara> 302 Moved Temporarily (old name,
RFC 2068)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-SEE-OTHER:CAPS" role="constant"/><literal>SOUP_STATUS_SEE_OTHER</literal></term>
<listitem><simpara> 303 See Other (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-NOT-MODIFIED:CAPS" role="constant"/><literal>SOUP_STATUS_NOT_MODIFIED</literal></term>
<listitem><simpara> 304 Not Modified (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-USE-PROXY:CAPS" role="constant"/><literal>SOUP_STATUS_USE_PROXY</literal></term>
<listitem><simpara> 305 Use Proxy (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-NOT-APPEARING-IN-THIS-PROTOCOL:CAPS" role="constant"/><literal>SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL</literal></term>
<listitem><simpara> 306 [Unused] (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-TEMPORARY-REDIRECT:CAPS" role="constant"/><literal>SOUP_STATUS_TEMPORARY_REDIRECT</literal></term>
<listitem><simpara> 307 Temporary Redirect (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-BAD-REQUEST:CAPS" role="constant"/><literal>SOUP_STATUS_BAD_REQUEST</literal></term>
<listitem><simpara> 400 Bad Request (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-UNAUTHORIZED:CAPS" role="constant"/><literal>SOUP_STATUS_UNAUTHORIZED</literal></term>
<listitem><simpara> 401 Unauthorized (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-PAYMENT-REQUIRED:CAPS" role="constant"/><literal>SOUP_STATUS_PAYMENT_REQUIRED</literal></term>
<listitem><simpara> 402 Payment Required (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-FORBIDDEN:CAPS" role="constant"/><literal>SOUP_STATUS_FORBIDDEN</literal></term>
<listitem><simpara> 403 Forbidden (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-NOT-FOUND:CAPS" role="constant"/><literal>SOUP_STATUS_NOT_FOUND</literal></term>
<listitem><simpara> 404 Not Found (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-METHOD-NOT-ALLOWED:CAPS" role="constant"/><literal>SOUP_STATUS_METHOD_NOT_ALLOWED</literal></term>
<listitem><simpara> 405 Method Not Allowed (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-NOT-ACCEPTABLE:CAPS" role="constant"/><literal>SOUP_STATUS_NOT_ACCEPTABLE</literal></term>
<listitem><simpara> 406 Not Acceptable (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-PROXY-AUTHENTICATION-REQUIRED:CAPS" role="constant"/><literal>SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED</literal></term>
<listitem><simpara> 407 Proxy Authentication
Required (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-PROXY-UNAUTHORIZED:CAPS" role="constant"/><literal>SOUP_STATUS_PROXY_UNAUTHORIZED</literal></term>
<listitem><simpara> shorter alias for
<link linkend="SOUP-STATUS-PROXY-AUTHENTICATION-REQUIRED:CAPS"><literal>SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED</literal></link>
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-REQUEST-TIMEOUT:CAPS" role="constant"/><literal>SOUP_STATUS_REQUEST_TIMEOUT</literal></term>
<listitem><simpara> 408 Request Timeout (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-CONFLICT:CAPS" role="constant"/><literal>SOUP_STATUS_CONFLICT</literal></term>
<listitem><simpara> 409 Conflict (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-GONE:CAPS" role="constant"/><literal>SOUP_STATUS_GONE</literal></term>
<listitem><simpara> 410 Gone (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-LENGTH-REQUIRED:CAPS" role="constant"/><literal>SOUP_STATUS_LENGTH_REQUIRED</literal></term>
<listitem><simpara> 411 Length Required (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-PRECONDITION-FAILED:CAPS" role="constant"/><literal>SOUP_STATUS_PRECONDITION_FAILED</literal></term>
<listitem><simpara> 412 Precondition Failed (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-REQUEST-ENTITY-TOO-LARGE:CAPS" role="constant"/><literal>SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE</literal></term>
<listitem><simpara> 413 Request Entity Too Large
(HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-REQUEST-URI-TOO-LONG:CAPS" role="constant"/><literal>SOUP_STATUS_REQUEST_URI_TOO_LONG</literal></term>
<listitem><simpara> 414 Request-URI Too Long (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-UNSUPPORTED-MEDIA-TYPE:CAPS" role="constant"/><literal>SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE</literal></term>
<listitem><simpara> 415 Unsupported Media Type
(HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-REQUESTED-RANGE-NOT-SATISFIABLE:CAPS" role="constant"/><literal>SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE</literal></term>
<listitem><simpara> 416 Requested Range
Not Satisfiable (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-INVALID-RANGE:CAPS" role="constant"/><literal>SOUP_STATUS_INVALID_RANGE</literal></term>
<listitem><simpara> shorter alias for
<link linkend="SOUP-STATUS-REQUESTED-RANGE-NOT-SATISFIABLE:CAPS"><literal>SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE</literal></link>
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-EXPECTATION-FAILED:CAPS" role="constant"/><literal>SOUP_STATUS_EXPECTATION_FAILED</literal></term>
<listitem><simpara> 417 Expectation Failed (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-UNPROCESSABLE-ENTITY:CAPS" role="constant"/><literal>SOUP_STATUS_UNPROCESSABLE_ENTITY</literal></term>
<listitem><simpara> 422 Unprocessable Entity
(WebDAV)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-LOCKED:CAPS" role="constant"/><literal>SOUP_STATUS_LOCKED</literal></term>
<listitem><simpara> 423 Locked (WebDAV)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-FAILED-DEPENDENCY:CAPS" role="constant"/><literal>SOUP_STATUS_FAILED_DEPENDENCY</literal></term>
<listitem><simpara> 424 Failed Dependency (WebDAV)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-INTERNAL-SERVER-ERROR:CAPS" role="constant"/><literal>SOUP_STATUS_INTERNAL_SERVER_ERROR</literal></term>
<listitem><simpara> 500 Internal Server Error
(HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-NOT-IMPLEMENTED:CAPS" role="constant"/><literal>SOUP_STATUS_NOT_IMPLEMENTED</literal></term>
<listitem><simpara> 501 Not Implemented (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-BAD-GATEWAY:CAPS" role="constant"/><literal>SOUP_STATUS_BAD_GATEWAY</literal></term>
<listitem><simpara> 502 Bad Gateway (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-SERVICE-UNAVAILABLE:CAPS" role="constant"/><literal>SOUP_STATUS_SERVICE_UNAVAILABLE</literal></term>
<listitem><simpara> 503 Service Unavailable (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-GATEWAY-TIMEOUT:CAPS" role="constant"/><literal>SOUP_STATUS_GATEWAY_TIMEOUT</literal></term>
<listitem><simpara> 504 Gateway Timeout (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-HTTP-VERSION-NOT-SUPPORTED:CAPS" role="constant"/><literal>SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED</literal></term>
<listitem><simpara> 505 HTTP Version Not
Supported (HTTP)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-INSUFFICIENT-STORAGE:CAPS" role="constant"/><literal>SOUP_STATUS_INSUFFICIENT_STORAGE</literal></term>
<listitem><simpara> 507 Insufficient Storage
(WebDAV)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-STATUS-NOT-EXTENDED:CAPS" role="constant"/><literal>SOUP_STATUS_NOT_EXTENDED</literal></term>
<listitem><simpara> 510 Not Extended (RFC 2774)
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-status-get-phrase" role="function"/>soup_status_get_phrase ()</title>
<indexterm><primary>soup_status_get_phrase</primary></indexterm><programlisting>const <link linkend="char">char</link>* soup_status_get_phrase (<link linkend="guint">guint</link> status_code);</programlisting>
<para>
Looks up the stock HTTP description of <parameter>status_code</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>status_code</parameter> :</term>
<listitem><simpara> an HTTP status code
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the (English) description of <parameter>status_code</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|