summaryrefslogtreecommitdiff
path: root/doc/ref/status.xml
blob: 56616ea6c2d22efe68224c96cd504f28e7cddeb1 (plain)
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
    <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 &lt;ne_utils.h&gt;

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>