diff options
Diffstat (limited to 'docs/man/nng_http_res_copy_data.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_res_copy_data.3http.adoc | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/man/nng_http_res_copy_data.3http.adoc b/docs/man/nng_http_res_copy_data.3http.adoc new file mode 100644 index 00000000..5542c441 --- /dev/null +++ b/docs/man/nng_http_res_copy_data.3http.adoc @@ -0,0 +1,60 @@ += nng_http_res_copy_data(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_copy_data - copy HTTP response body + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> +#include <nng/supplemental/http/http.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.3http#,`nni_http_conn_write_res()`>>. + +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.3http#,`nng_http_res_set_data()`>> 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.3http#,nng_http_conn_write_res(3http)>>, +<<nng_http_res_alloc.3http#,nng_http_res_alloc(3http)>>, +<<nng_http_res_set_data.3http#,nng_http_res_set_data(3http)>>, +<<nng_http_res_set_header.3http#,nng_http_res_set_header(3http)>>, +<<nng.7#,nng(7)>> |