diff options
Diffstat (limited to 'doc/ref/status.xml')
-rw-r--r-- | doc/ref/status.xml | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/ref/status.xml b/doc/ref/status.xml new file mode 100644 index 0000000..56616ea --- /dev/null +++ b/doc/ref/status.xml @@ -0,0 +1,74 @@ + <refentry id="refstatus"> + + <refmeta> + <refentrytitle>ne_status</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname id="ne_status">ne_status</refname> + <refpurpose>HTTP status structure</refpurpose> + </refnamediv> + + <refsynopsisdiv> + + <funcsynopsis><funcsynopsisinfo>#include <ne_utils.h> + +typedef struct { + int major_version, minor_version; + int code, klass; + const char *reason_phrase; +} <type>ne_status</type>;</funcsynopsisinfo></funcsynopsis> + + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>An <type>ne_status</type> type represents an HTTP +response status; used in response messages giving a result of request. +The <structfield>major_version</structfield> and +<structfield>minor_version</structfield> fields give the HTTP version +supported by the server issuing the response. The +<structfield>code</structfield> field gives the status code of the +result (lying between 100 and 999 inclusive), and the +<structfield>klass</structfield> field gives the class, which is equal +to the most significant digit of the status.</para> + + <para>There are five classes of HTTP status code defined by + RFC2616:</para> + + <variablelist> + <varlistentry> + <term><literal>1xx</literal></term> + <listitem><para>Informational response.</para></listitem> + </varlistentry> + + <varlistentry> + <term><literal>2xx</literal></term> + <listitem><para>Success: the operation was successful</para></listitem> + </varlistentry> + + <varlistentry> + <term><literal>3xx</literal></term> + <listitem><para>Redirection</para></listitem> + </varlistentry> + + <varlistentry> + <term><literal>4xx</literal></term> <listitem><para>Client + error: the request made was incorrect in some + manner.</para></listitem> + </varlistentry> + + <varlistentry> + <term><literal>5xx</literal></term> + <listitem><para>Server error</para></listitem> + </varlistentry> + </variablelist> + + </refsect1> + + <refsect1> <title>See also</title> <para><xref +linkend="ne_get_status"/>.</para> </refsect1> + + </refentry> |