diff options
Diffstat (limited to 'docs/nng_http_res_copy_data.adoc')
| -rw-r--r-- | docs/nng_http_res_copy_data.adoc | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/docs/nng_http_res_copy_data.adoc b/docs/nng_http_res_copy_data.adoc deleted file mode 100644 index 56d10222..00000000 --- a/docs/nng_http_res_copy_data.adoc +++ /dev/null @@ -1,60 +0,0 @@ -= nng_http_res_copy_data(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_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#,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)>> |