Debian Codegraph @

deps/libneon/doc/ref/status.xml

raw
1 <refentry id="refstatus">
2
3 <refmeta>
4 <refentrytitle>ne_status</refentrytitle>
5 <manvolnum>3</manvolnum>
6 </refmeta>
7
8 <refnamediv>
9 <refname id="ne_status">ne_status</refname>
10 <refpurpose>HTTP status structure</refpurpose>
11 </refnamediv>
12
13 <refsynopsisdiv>
14
15 <funcsynopsis><funcsynopsisinfo>#include &lt;ne_utils.h&gt;
16
17 typedef struct {
18 int major_version, minor_version;
19 int code, klass;
20 const char *reason_phrase;
21 } <type>ne_status</type>;</funcsynopsisinfo></funcsynopsis>
22
23 </refsynopsisdiv>
24
25 <refsect1>
26 <title>Description</title>
27
28 <para>An <type>ne_status</type> type represents an HTTP
29 response status; used in response messages giving a result of request.
30 The <structfield>major_version</structfield> and
31 <structfield>minor_version</structfield> fields give the HTTP version
32 supported by the server issuing the response. The
33 <structfield>code</structfield> field gives the status code of the
34 result (lying between 100 and 999 inclusive), and the
35 <structfield>klass</structfield> field gives the
36 class<footnote><para>the field is named <quote>klass</quote> not
37 <quote>class</quote> so that the header can be used from a C++
38 program, in which <quote>class</quote> is a reserved
39 word)</para></footnote>, which is equal to the most significant digit
40 of the status.</para>
41
42 <para>There are five classes of HTTP status code defined by
43 RFC2616:</para>
44
45 <variablelist>
46 <varlistentry>
47 <term><literal>1xx</literal></term>
48 <listitem><simpara>Informational response.</simpara></listitem>
49 </varlistentry>
50
51 <varlistentry>
52 <term><literal>2xx</literal></term>
53 <listitem><simpara>Success: the operation was successful</simpara></listitem>
54 </varlistentry>
55
56 <varlistentry>
57 <term><literal>3xx</literal></term>
58 <listitem><simpara>Redirection</simpara></listitem>
59 </varlistentry>
60
61 <varlistentry>
62 <term><literal>4xx</literal></term> <listitem><simpara>Client
63 error: the request made was incorrect in some
64 manner.</simpara></listitem>
65 </varlistentry>
66
67 <varlistentry>
68 <term><literal>5xx</literal></term>
69 <listitem><simpara>Server error</simpara></listitem>
70 </varlistentry>
71 </variablelist>
72
73 </refsect1>
74
75 <refsect1> <title>See also</title> <para><xref
76 linkend="ne_get_status"/>.</para> </refsect1>
77
78 </refentry>