blob: 7251f1cc1c8b02714dfa5e77b9bc550b10cbf16e (
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
|
= nng_http_res_get_reason(3http)
//
// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This document is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt). A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//
== NAME
nng_http_res_get_reason - return HTTP response reason
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
const char *nng_http_res_get_reason(nng_http_res *res);
----
== DESCRIPTION
The `nng_http_res_get_reason()` returns a string representing the
"`reason phrase`" associated with the response _res_.
This is a human-readable explanation of the status code that
would be obtained from
`<<nng_http_res_get_status.3http#,nng_http_res_get_status()>>`.
== RETURN VALUES
Reason as a string.
== ERRORS
None.
== SEE ALSO
<<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>,
<<nng_http_res_get_status.3http#,nng_http_res_get_status(3http)>>,
<<nng_http_res_set_reason.3http#,nng_http_res_set_reason(3http)>>,
<<nng.7#,nng(7)>>
|
