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
|
= nng_http_conn_read_res(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_conn_read_res - read HTTP response
== SYNOPSIS
[source, c]
----
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>
void nng_http_conn_read_res(nng_http_conn *conn, nng_http_res *res,
nng_aio *aio);
----
== DESCRIPTION
The `nng_http_conn_read_res()` function starts an asynchronous read from the
HTTP connection _conn_, reading an HTTP response into the _res_, including all
of the related headers.
NOTE: Any HTTP entity/body data associated with the response is *not* read
automatically.
The caller should use
xref:nng_http_conn_read_all.3http.adoc[`nng_http_conn_read_all`] to read the entity
data, based on the details of the response itself.
This function returns immediately, with no return value.
Completion of
the operation is signaled via the _aio_, and the final result may be
obtained via xref:nng_aio_result.3.adoc[`nng_aio_result()`].
That result will either be zero or an error code.
NOTE: Consider using the
xref:nng_http_client_transact.3http.adoc[`nng_http_client_transact()`] or
xref:nng_http_conn_transact.3http.adoc[`nng_http_conn_transact()`] functions,
which provide a simpler interface for performing a complete HTTP client
transaction.
== RETURN VALUES
None.
== ERRORS
[horizontal]
`NNG_ECANCELED`:: The operation was canceled.
`NNG_ECLOSED`:: The connection was closed.
`NNG_ECONNRESET`:: The peer closed the connection.
`NNG_ENOMEM`:: Insufficient free memory to perform the operation.
`NNG_ENOTSUP`:: HTTP operations are not supported.
`NNG_ETIMEDOUT`:: Timeout waiting for data from the connection.
== SEE ALSO
[.text-left]
xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
xref:nng_aio_result.3.adoc[nng_aio_result(3)],
xref:nng_strerror.3.adoc[nng_strerror(3)],
xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)],
xref:nng_http_client_transact.3http.adoc[nng_http_client_transact(3http)],
xref:nng_http_conn_transact.3http.adoc[nng_http_conn_transact(3http)],
xref:nng_http_conn_read_all.3http.adoc[nng_http_conn_read_all(3http)],
xref:nng.7.adoc[nng(7)]
|
