aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_res_copy_data.adoc
blob: 2034c033052287335f6f07ba564b9a67f0da2960 (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
= nng_http_res_copy_data(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \
            Copyright 2018 Capitar IT Group BV <info@capitar.com> \
            This software 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_copy_data - copy HTTP response body

== SYNOPSIS

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

int nng_http_res_copy_data(nng_http_res *res, const void *body, size_t size);
-----------

== DESCRIPTION

The `nng_http_res_copy_data()` makes a copy of _body_ (of size __size__)
and sets the HTTP body for the response _res_ to it.  The copy will be
deallocated automatically when _res_ is freed.

The copied body data will be automatically sent with the response when it
is sent using <<nng_http_conn_write_res#,nni_http_conn_write_res(3)>>.

This also updates the relevant `Content-Length` header of _res_.

NOTE: The current framework does not support sending data via chunked
transfer-encoding.

TIP: To avoid copying data, the
<<nng_http_res_set_data#,nng_http_res_set_data(3)>> may be used instead.

TIP: It is a good idea to also set the `Content-Type` header.

== RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

== ERRORS

`NNG_ENOMEM`:: Insufficient memory to perform the operation.
`NNG_ENOTSUP`:: No support for HTTP in the library.

== SEE ALSO

<<nng_http_conn_write_res#,nng_http_conn_write_res(3)>>,
<<nng_http_res_alloc#,nng_http_res_alloc(3)>>,
<<nng_http_res_set_data#,nng_http_res_set_data(3)>>,
<<nng_http_res_set_header#,nng_http_res_set_header(3)>>,
<<nng#,nng(7)>>

== COPYRIGHT

Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] +
Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]

This document is supplied under the terms of the
https://opensource.org/licenses/MIT[MIT License].