Document HTTP request/reply structures and handling.

1 files changed, 68 insertions, 0 deletions

diff --git a/docs/nng_http_req_copy_data.adoc b/docs/nng_http_req_copy_data.adoc
new file mode 100644
index 00000000..0ae54cf0
--- /dev/null
+++ b/docs/nng_http_req_copy_data.adoc
@@ -0,0 +1,68 @@
+= nng_http_req_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_req_copy_data - copy HTTP request body
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_http_req_copy_data(nng_http_req *req, const void *body, size_t size);
+-----------
+
+== DESCRIPTION
+
+The `nng_http_req_copy_data()` makes a copy of _body_ (of size __size__)
+and sets the HTTP body for the request _req_ to it.  The copy will be
+deallocated automatically when _req_ is freed.
+
+The copied body data will be automatically sent with the request when it
+is sent using <<nng_http_conn_write_req#,nni_http_conn_write_req(3)>>.
+
+This also updates the relevant `Content-Length` header of _req_.
+
+NOTE: The current framework does not support sending data via chunked
+transfer-encoding.
+
+TIP: To avoid copying data, the
+<<nng_http_req_set_data#,nng_http_req_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_req#,nng_http_conn_write_req(3)>>,
+<<nng_http_req_alloc#,nng_http_req_alloc(3)>>,
+<<nng_http_req_set_data#,nng_http_req_set_data(3)>>,
+<<nng_http_req_set_header#,nng_http_req_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].