Debian Codegraph @

deps/libneon/doc/man/ne_status.3

raw
1 '\" t
2 .\" Title: ne_status
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\" Date: 3 May 2011
6 .\" Manual: neon API reference
7 .\" Source: neon 0.29.6
8 .\" Language: English
9 .\"
10 .TH "NE_STATUS" "3" "3 May 2011" "neon 0.29.6" "neon API reference"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 ne_status \- HTTP status structure
32 .SH "SYNOPSIS"
33 .sp
34 .ft B
35 .nf
36 #include <ne_utils\&.h>
37
38 typedef struct {
39 int major_version, minor_version;
40 int code, klass;
41 const char *reason_phrase;
42 } ne_status;
43 .fi
44 .ft
45 .SH "DESCRIPTION"
46 .PP
47 An
48 \fBne_status\fR
49 type represents an HTTP response status; used in response messages giving a result of request\&. The
50 \fImajor_version\fR
51 and
52 \fIminor_version\fR
53 fields give the HTTP version supported by the server issuing the response\&. The
54 \fIcode\fR
55 field gives the status code of the result (lying between 100 and 999 inclusive), and the
56 \fIklass\fR
57 field gives the class\&\s-2\u[1]\d\s+2, which is equal to the most significant digit of the status\&.
58 .PP
59 There are five classes of HTTP status code defined by RFC2616:
60 .PP
61 1xx
62 .RS 4
63 Informational response\&.
64 .RE
65 .PP
66 2xx
67 .RS 4
68 Success: the operation was successful
69 .RE
70 .PP
71 3xx
72 .RS 4
73 Redirection
74 .RE
75 .PP
76 4xx
77 .RS 4
78 Client error: the request made was incorrect in some manner\&.
79 .RE
80 .PP
81 5xx
82 .RS 4
83 Server error
84 .RE
85 .SH "SEE ALSO"
86 .PP
87 ne_get_status\&.
88 .SH "AUTHOR"
89 .PP
90 \fBJoe Orton\fR <\&[email protected]\&>
91 .RS 4
92 Author.
93 .RE
94 .SH "COPYRIGHT"
95 .br
96 .SH "NOTES"
97 .IP " 1." 4
98 the field is named
99 \(lqklass\(rq
100 not
101 \(lqclass\(rq
102 so that the header can be used from a C++ program, in which
103 \(lqclass\(rq
104 is a reserved word)
105