man/v1.3.2/nng_http_res_get_status.3http.html


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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

---
version: v1.3.2
layout: manpage_v2
---
<h1>nng_http_res_get_status(3http)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_http_res_get_status - return HTTP status code</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="c"><span class="tok-cp">#include</span> <span class="tok-cpf">&lt;nng/nng.h&gt;</span><span class="tok-cp">
</span><span class="tok-cp">#include</span> <span class="tok-cpf">&lt;nng/supplemental/http/http.h&gt;</span><span class="tok-cp">
</span><span class="tok-cp"></span>
<span class="tok-n">uint16_t</span> <span class="tok-nf">nng_http_res_get_status</span><span class="tok-p">(</span><span class="tok-n">nng_http_res</span> <span class="tok-o">*</span><span class="tok-n">res</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>nng_http_res_get_status()</code> returns a numeric code corresponding to
the HTTP status of the response <em>res</em>.</p>
</div>
<div class="paragraph">
<p>For convenience, a number of predefined symbols corresponding to well-known
HTTP status codes are available.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="c"><span class="tok-k">enum</span> <span class="tok-p">{</span>
    <span class="tok-n">NNG_HTTP_STATUS_CONTINUE</span>                 <span class="tok-o">=</span> <span class="tok-mi">100</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_SWITCHING</span>                <span class="tok-o">=</span> <span class="tok-mi">101</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_PROCESSING</span>               <span class="tok-o">=</span> <span class="tok-mi">102</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_OK</span>                       <span class="tok-o">=</span> <span class="tok-mi">200</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_CREATED</span>                  <span class="tok-o">=</span> <span class="tok-mi">201</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_ACCEPTED</span>                 <span class="tok-o">=</span> <span class="tok-mi">202</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_NOT_AUTHORITATIVE</span>        <span class="tok-o">=</span> <span class="tok-mi">203</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_NO_CONTENT</span>               <span class="tok-o">=</span> <span class="tok-mi">204</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_RESET_CONTENT</span>            <span class="tok-o">=</span> <span class="tok-mi">205</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_PARTIAL_CONTENT</span>          <span class="tok-o">=</span> <span class="tok-mi">206</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_MULTI_STATUS</span>             <span class="tok-o">=</span> <span class="tok-mi">207</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_ALREADY_REPORTED</span>         <span class="tok-o">=</span> <span class="tok-mi">208</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_IM_USED</span>                  <span class="tok-o">=</span> <span class="tok-mi">226</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_MULTIPLE_CHOICES</span>         <span class="tok-o">=</span> <span class="tok-mi">300</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_STATUS_MOVED_PERMANENTLY</span> <span class="tok-o">=</span> <span class="tok-mi">301</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_FOUND</span>                    <span class="tok-o">=</span> <span class="tok-mi">302</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_SEE_OTHER</span>                <span class="tok-o">=</span> <span class="tok-mi">303</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_NOT_MODIFIED</span>             <span class="tok-o">=</span> <span class="tok-mi">304</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_USE_PROXY</span>                <span class="tok-o">=</span> <span class="tok-mi">305</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_TEMPORARY_REDIRECT</span>       <span class="tok-o">=</span> <span class="tok-mi">307</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_PERMANENT_REDIRECT</span>       <span class="tok-o">=</span> <span class="tok-mi">308</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_BAD_REQUEST</span>              <span class="tok-o">=</span> <span class="tok-mi">400</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_UNAUTHORIZED</span>             <span class="tok-o">=</span> <span class="tok-mi">401</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_PAYMENT_REQUIRED</span>         <span class="tok-o">=</span> <span class="tok-mi">402</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_FORBIDDEN</span>                <span class="tok-o">=</span> <span class="tok-mi">403</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_NOT_FOUND</span>                <span class="tok-o">=</span> <span class="tok-mi">404</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_METHOD_NOT_ALLOWED</span>       <span class="tok-o">=</span> <span class="tok-mi">405</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_NOT_ACCEPTABLE</span>           <span class="tok-o">=</span> <span class="tok-mi">406</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_PROXY_AUTH_REQUIRED</span>      <span class="tok-o">=</span> <span class="tok-mi">407</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_REQUEST_TIMEOUT</span>          <span class="tok-o">=</span> <span class="tok-mi">408</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_CONFLICT</span>                 <span class="tok-o">=</span> <span class="tok-mi">409</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_GONE</span>                     <span class="tok-o">=</span> <span class="tok-mi">410</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_LENGTH_REQUIRED</span>          <span class="tok-o">=</span> <span class="tok-mi">411</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_PRECONDITION_FAILED</span>      <span class="tok-o">=</span> <span class="tok-mi">412</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_PAYLOAD_TOO_LARGE</span>        <span class="tok-o">=</span> <span class="tok-mi">413</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_ENTITY_TOO_LONG</span>          <span class="tok-o">=</span> <span class="tok-mi">414</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE</span>   <span class="tok-o">=</span> <span class="tok-mi">415</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_RANGE_NOT_SATISFIABLE</span>    <span class="tok-o">=</span> <span class="tok-mi">416</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_EXPECTATION_FAILED</span>       <span class="tok-o">=</span> <span class="tok-mi">417</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_TEAPOT</span>                   <span class="tok-o">=</span> <span class="tok-mi">418</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_UNPROCESSABLE_ENTITY</span>     <span class="tok-o">=</span> <span class="tok-mi">422</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_LOCKED</span>                   <span class="tok-o">=</span> <span class="tok-mi">423</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_FAILED_DEPENDENCY</span>        <span class="tok-o">=</span> <span class="tok-mi">424</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_UPGRADE_REQUIRED</span>         <span class="tok-o">=</span> <span class="tok-mi">426</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_PRECONDITION_REQUIRED</span>    <span class="tok-o">=</span> <span class="tok-mi">428</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_TOO_MANY_REQUESTS</span>        <span class="tok-o">=</span> <span class="tok-mi">429</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_HEADERS_TOO_LARGE</span>        <span class="tok-o">=</span> <span class="tok-mi">431</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_UNAVAIL_LEGAL_REASONS</span>    <span class="tok-o">=</span> <span class="tok-mi">451</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_INTERNAL_SERVER_ERROR</span>    <span class="tok-o">=</span> <span class="tok-mi">500</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_NOT_IMPLEMENTED</span>          <span class="tok-o">=</span> <span class="tok-mi">501</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_BAD_GATEWAY</span>              <span class="tok-o">=</span> <span class="tok-mi">502</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_SERVICE_UNAVAILABLE</span>      <span class="tok-o">=</span> <span class="tok-mi">503</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_GATEWAY_TIMEOUT</span>          <span class="tok-o">=</span> <span class="tok-mi">504</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_HTTP_VERSION_NOT_SUPP</span>    <span class="tok-o">=</span> <span class="tok-mi">505</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_VARIANT_ALSO_NEGOTIATES</span>  <span class="tok-o">=</span> <span class="tok-mi">506</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_INSUFFICIENT_STORAGE</span>     <span class="tok-o">=</span> <span class="tok-mi">507</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_LOOP_DETECTED</span>            <span class="tok-o">=</span> <span class="tok-mi">508</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_NOT_EXTENDED</span>             <span class="tok-o">=</span> <span class="tok-mi">510</span><span class="tok-p">,</span>
    <span class="tok-n">NNG_HTTP_STATUS_NETWORK_AUTH_REQUIRED</span>    <span class="tok-o">=</span> <span class="tok-mi">511</span><span class="tok-p">,</span>
<span class="tok-p">}</span></code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
When displaying status information to users (or logging such information),
consider also including the reason obtained with
<a href="nng_http_res_get_reason.3http.html"><code>nng_http_res_get_reason()</code></a>.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>HTTP status code.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph text-left">
<p><a href="nng_http_res_alloc.3http.html">nng_http_res_alloc(3http)</a>,
<a href="nng_http_res_get_reason.3http.html">nng_http_res_get_reason(3http)</a>,
<a href="nng_http_res_set_status.3http.html">nng_http_res_set_status(3http)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>