diff options
Diffstat (limited to 'docs/reference/tmpl/soup-status.sgml')
| -rw-r--r-- | docs/reference/tmpl/soup-status.sgml | 174 |
1 files changed, 94 insertions, 80 deletions
diff --git a/docs/reference/tmpl/soup-status.sgml b/docs/reference/tmpl/soup-status.sgml index 4d45ea45..374a820b 100644 --- a/docs/reference/tmpl/soup-status.sgml +++ b/docs/reference/tmpl/soup-status.sgml @@ -2,7 +2,7 @@ soup-status <!-- ##### SECTION Short_Description ##### --> - +HTTP and Soup status codes <!-- ##### SECTION Long_Description ##### --> <para> @@ -16,122 +16,136 @@ soup-status <!-- ##### ENUM SoupStatusClass ##### --> <para> - +The classes of HTTP and Soup status codes </para> -@SOUP_STATUS_CLASS_TRANSPORT_ERROR: -@SOUP_STATUS_CLASS_INFORMATIONAL: -@SOUP_STATUS_CLASS_SUCCESS: -@SOUP_STATUS_CLASS_REDIRECT: -@SOUP_STATUS_CLASS_CLIENT_ERROR: -@SOUP_STATUS_CLASS_SERVER_ERROR: +@SOUP_STATUS_CLASS_TRANSPORT_ERROR: Network or Soup-level error +@SOUP_STATUS_CLASS_INFORMATIONAL: HTTP 1xx response providing partial +information about the state of a request +@SOUP_STATUS_CLASS_SUCCESS: HTTP 2xx successful response +@SOUP_STATUS_CLASS_REDIRECT: HTTP 3xx redirection response +@SOUP_STATUS_CLASS_CLIENT_ERROR: HTTP 4xx client error response +@SOUP_STATUS_CLASS_SERVER_ERROR: HTTP 5xx server error response <!-- ##### MACRO SOUP_STATUS_IS_INFORMATIONAL ##### --> <para> - +Tests if @status is an Informational (1xx) response. </para> -@x: +@status: an HTTP status code +@Returns: %TRUE if @status is an Information (1xx) response. <!-- ##### MACRO SOUP_STATUS_IS_SUCCESSFUL ##### --> <para> - +Tests if @status is a Successful (2xx) response. </para> -@x: +@status: an HTTP status code +@Returns: %TRUE if @status is a Successful (2xx) response. <!-- ##### MACRO SOUP_STATUS_IS_REDIRECTION ##### --> <para> - +Tests if @status is a Redirection (3xx) response. </para> -@x: +@status: an HTTP status code +@Returns: %TRUE if @status is a Redirection (3xx) response. <!-- ##### MACRO SOUP_STATUS_IS_CLIENT_ERROR ##### --> <para> - +Tests if @status is a Client Error (4xx) response. </para> -@x: +@status: an HTTP status code +@Returns: %TRUE if @status is a Client Error (4xx) response. <!-- ##### MACRO SOUP_STATUS_IS_SERVER_ERROR ##### --> <para> - +Tests if @status is a Server Error (5xx) response. </para> -@x: +@status: an HTTP status code +@Returns: %TRUE if @status is a Server Error (5xx) response. <!-- ##### ENUM SoupKnownStatusCode ##### --> <para> - +These represent the known HTTP status code values, plus various +network and internal errors. </para> -@SOUP_STATUS_NONE: -@SOUP_STATUS_CANCELLED: -@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: -@SOUP_STATUS_CONTINUE: -@SOUP_STATUS_SWITCHING_PROTOCOLS: -@SOUP_STATUS_PROCESSING: -@SOUP_STATUS_OK: -@SOUP_STATUS_CREATED: -@SOUP_STATUS_ACCEPTED: -@SOUP_STATUS_NON_AUTHORITATIVE: -@SOUP_STATUS_NO_CONTENT: -@SOUP_STATUS_RESET_CONTENT: -@SOUP_STATUS_PARTIAL_CONTENT: -@SOUP_STATUS_MULTI_STATUS: -@SOUP_STATUS_MULTIPLE_CHOICES: -@SOUP_STATUS_MOVED_PERMANENTLY: -@SOUP_STATUS_FOUND: -@SOUP_STATUS_MOVED_TEMPORARILY: -@SOUP_STATUS_SEE_OTHER: -@SOUP_STATUS_NOT_MODIFIED: -@SOUP_STATUS_USE_PROXY: -@SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL: -@SOUP_STATUS_TEMPORARY_REDIRECT: -@SOUP_STATUS_BAD_REQUEST: -@SOUP_STATUS_UNAUTHORIZED: -@SOUP_STATUS_PAYMENT_REQUIRED: -@SOUP_STATUS_FORBIDDEN: -@SOUP_STATUS_NOT_FOUND: -@SOUP_STATUS_METHOD_NOT_ALLOWED: -@SOUP_STATUS_NOT_ACCEPTABLE: -@SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED: -@SOUP_STATUS_PROXY_UNAUTHORIZED: -@SOUP_STATUS_REQUEST_TIMEOUT: -@SOUP_STATUS_CONFLICT: -@SOUP_STATUS_GONE: -@SOUP_STATUS_LENGTH_REQUIRED: -@SOUP_STATUS_PRECONDITION_FAILED: -@SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE: -@SOUP_STATUS_REQUEST_URI_TOO_LONG: -@SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE: -@SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE: -@SOUP_STATUS_INVALID_RANGE: -@SOUP_STATUS_EXPECTATION_FAILED: -@SOUP_STATUS_UNPROCESSABLE_ENTITY: -@SOUP_STATUS_LOCKED: -@SOUP_STATUS_FAILED_DEPENDENCY: -@SOUP_STATUS_INTERNAL_SERVER_ERROR: -@SOUP_STATUS_NOT_IMPLEMENTED: -@SOUP_STATUS_BAD_GATEWAY: -@SOUP_STATUS_SERVICE_UNAVAILABLE: -@SOUP_STATUS_GATEWAY_TIMEOUT: -@SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED: -@SOUP_STATUS_INSUFFICIENT_STORAGE: -@SOUP_STATUS_NOT_EXTENDED: +@SOUP_STATUS_NONE: No status available. (Eg, the message has not been +sent yet) +@SOUP_STATUS_CANCELLED: Message was cancelled locally +@SOUP_STATUS_CANT_RESOLVE: Unable to resolve destination host name +@SOUP_STATUS_CANT_RESOLVE_PROXY: Unable to resolve proxy host name +@SOUP_STATUS_CANT_CONNECT: Unable to connect to remote host +@SOUP_STATUS_CANT_CONNECT_PROXY: Unable to connect to proxy +@SOUP_STATUS_SSL_FAILED: SSL negotiation failed +@SOUP_STATUS_IO_ERROR: A network error occurred, or the other end +closed the connection unexpectedly +@SOUP_STATUS_MALFORMED: Malformed data (usually a programmer error) +@SOUP_STATUS_TRY_AGAIN: Try again. (Only returned in certain +specifically documented cases) +@SOUP_STATUS_CONTINUE: 100 Continue (HTTP) +@SOUP_STATUS_SWITCHING_PROTOCOLS: 101 Switching Protocols (HTTP) +@SOUP_STATUS_PROCESSING: 102 Processing (WebDAV) +@SOUP_STATUS_OK: 200 Success (HTTP). Also used by many lower-level +soup routines to indicate success. +@SOUP_STATUS_CREATED: 201 Created (HTTP) +@SOUP_STATUS_ACCEPTED: 202 Accepted (HTTP) +@SOUP_STATUS_NON_AUTHORITATIVE: 203 Non-Authoritative Information (HTTP) +@SOUP_STATUS_NO_CONTENT: 204 No Content (HTTP) +@SOUP_STATUS_RESET_CONTENT: 205 Reset Content (HTTP) +@SOUP_STATUS_PARTIAL_CONTENT: 206 Partial Content (HTTP) +@SOUP_STATUS_MULTI_STATUS: 207 Multi-Status (WebDAV) +@SOUP_STATUS_MULTIPLE_CHOICES: 300 Multiple Choices (HTTP) +@SOUP_STATUS_MOVED_PERMANENTLY: 301 Moved Permanently (HTTP) +@SOUP_STATUS_FOUND: 302 Found (HTTP) +@SOUP_STATUS_MOVED_TEMPORARILY: 302 Moved Temporarily (old name, RFC 2068) +@SOUP_STATUS_SEE_OTHER: 303 See Other (HTTP) +@SOUP_STATUS_NOT_MODIFIED: 304 Not Modified (HTTP) +@SOUP_STATUS_USE_PROXY: 305 Use Proxy (HTTP) +@SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL: 306 [Unused] (HTTP) +@SOUP_STATUS_TEMPORARY_REDIRECT: 307 Temporary Redirect (HTTP) +@SOUP_STATUS_BAD_REQUEST: 400 Bad Request (HTTP) +@SOUP_STATUS_UNAUTHORIZED: 401 Unauthorized (HTTP) +@SOUP_STATUS_PAYMENT_REQUIRED: 402 Payment Required (HTTP) +@SOUP_STATUS_FORBIDDEN: 403 Forbidden (HTTP) +@SOUP_STATUS_NOT_FOUND: 404 Not Found (HTTP) +@SOUP_STATUS_METHOD_NOT_ALLOWED: 405 Method Not Allowed (HTTP) +@SOUP_STATUS_NOT_ACCEPTABLE: 406 Not Acceptable (HTTP) +@SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED: 407 Proxy Authentication +Required (HTTP) +@SOUP_STATUS_PROXY_UNAUTHORIZED: shorter alias for %SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED +@SOUP_STATUS_REQUEST_TIMEOUT: 408 Request Timeout (HTTP) +@SOUP_STATUS_CONFLICT: 409 Conflict (HTTP) +@SOUP_STATUS_GONE: 410 Gone (HTTP) +@SOUP_STATUS_LENGTH_REQUIRED: 411 Length Required (HTTP) +@SOUP_STATUS_PRECONDITION_FAILED: 412 Precondition Failed (HTTP) +@SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE: 413 Request Entity Too Large (HTTP) +@SOUP_STATUS_REQUEST_URI_TOO_LONG: 414 Request-URI Too Long (HTTP) +@SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE: 415 Unsupported Media Type (HTTP) +@SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE: 416 Requested Range Not +Satisfiable (HTTP) +@SOUP_STATUS_INVALID_RANGE: shorter alias for %SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE +@SOUP_STATUS_EXPECTATION_FAILED: 417 Expectation Failed (HTTP) +@SOUP_STATUS_UNPROCESSABLE_ENTITY: 422 Unprocessable Entity (WebDAV) +@SOUP_STATUS_LOCKED: 423 Locked (WebDAV) +@SOUP_STATUS_FAILED_DEPENDENCY: 424 Failed Dependency (WebDAV) +@SOUP_STATUS_INTERNAL_SERVER_ERROR: 500 Internal Server Error (HTTP) +@SOUP_STATUS_NOT_IMPLEMENTED: 501 Not Implemented (HTTP) +@SOUP_STATUS_BAD_GATEWAY: 502 Bad Gateway (HTTP) +@SOUP_STATUS_SERVICE_UNAVAILABLE: 503 Service Unavailable (HTTP) +@SOUP_STATUS_GATEWAY_TIMEOUT: 504 Gateway Timeout (HTTP) +@SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED: 505 HTTP Version Not +Supported (HTTP) +@SOUP_STATUS_INSUFFICIENT_STORAGE: 507 Insufficient Storage (WebDAV) +@SOUP_STATUS_NOT_EXTENDED: 510 Not Extended (RFC 2774) <!-- ##### FUNCTION soup_status_get_phrase ##### --> <para> |