aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_res_set_data.3http.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/nng_http_res_set_data.3http.adoc')
-rw-r--r--docs/man/nng_http_res_set_data.3http.adoc64
1 files changed, 0 insertions, 64 deletions
diff --git a/docs/man/nng_http_res_set_data.3http.adoc b/docs/man/nng_http_res_set_data.3http.adoc
deleted file mode 100644
index 7c4c06bc..00000000
--- a/docs/man/nng_http_res_set_data.3http.adoc
+++ /dev/null
@@ -1,64 +0,0 @@
-= nng_http_res_set_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_set_data - set HTTP response body
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/http/http.h>
-
-int nng_http_res_set_data(nng_http_res *res, const void *body, size_t size);
-----
-
-== DESCRIPTION
-
-The `nng_http_res_set_data()` sets the HTTP body associated with
-the response _res_ to _body_, and the size of the body to _size_.
-This body data will be automatically sent with the response when it
-is sent using xref:nng_http_conn_write_res.3http.adoc[`nng_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.
-
-The _body_ is *not* copied, and the caller must ensure that it is available
-until the _res_ is deallocated.
-
-TIP: To have a local copy allocated with _res_ that will be automatically
-deallocated when _res_ is freed,
-see xref:nng_http_res_copy_data.3http.adoc[`nng_http_res_copy_data()`].
-
-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
-
-[horizontal]
-`NNG_ENOMEM`:: Insufficient memory to perform the operation.
-`NNG_ENOTSUP`:: No support for HTTP in the library.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_http_conn_write_res.3http.adoc[nng_http_conn_write_res(3http)],
-xref:nng_http_res_alloc.3http.adoc[nng_http_res_alloc(3http)],
-xref:nng_http_res_copy_data.3http.adoc[nng_http_res_copy_data(3http)],
-xref:nng_http_res_set_header.3http.adoc[nng_http_res_set_header(3http)],
-xref:nng.7.adoc[nng(7)]