summaryrefslogtreecommitdiff
path: root/docs/man/nng_http_conn_write_res.adoc
blob: 72fc89ec749e8171af4e63edf46767271d4bf58e (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
= nng_http_conn_write_res(3)
//
// 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_write_res - write HTTP response

== SYNOPSIS

[source, c]
-----------
#include <nng/nng.h>
#include <nng/supplemental/http/http.h>

void nng_http_conn_write_res(nng_http_conn *conn, nng_http_res *res,
    nng_aio *aio);
-----------

== DESCRIPTION

The `nng_http_conn_write_res()` function starts an asynchronous write of
the HTTP response _res_ to the connection _conn_.  The entire response is sent,
including headers, and if present, the response body data.  (The
response body can be set with
<<nng_http_res_set_data#,nng_http_res_set_data(3)>> or
<<nng_http_res_copy_data#,nng_http_res_copy_data(3)>>.)

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 <<nng_aio_result#,nng_aio_result(3)>>. That result will
either be zero or an error code.

=== Persistent Connections

By default, for `HTTP/1.1` connections, the connection is kept open, and
will be reused to receive new requests.

If however the _res_ contains a header of `Connection:` with a value 
of `Close` (case-insensitive) or the response corresponds to `HTTP/1.0`,
then the connection is immediately after sending the response.

== RETURN VALUES

None.

== ERRORS

`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

<<nng_aio_alloc#,nng_aio_alloc(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng_http_client_connect#,nng_http_client_connect(3)>>,
<<nng_http_conn_read_all#,nng_http_conn_read_all(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>