Document HTTP request/reply structures and handling.

1 files changed, 73 insertions, 0 deletions

diff --git a/docs/nng_http_res_alloc.adoc b/docs/nng_http_res_alloc.adoc
new file mode 100644
index 00000000..73dbccf5
--- /dev/null
+++ b/docs/nng_http_res_alloc.adoc
@@ -0,0 +1,73 @@
+= nng_http_res_alloc(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_alloc - allocate HTTP response structure
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_http_res_alloc(nng_http_res **resp);
+-----------
+
+
+== DESCRIPTION
+
+The `nng_http_res_alloc()` function allocates a new HTTP response structure
+and stores a pointer to it in __resp__.  The response will be initialized
+with status code 200 (`NNG_HTTP_STATUS_OK`), and a reason phrase of "OK",
+and HTTP protocol version "HTTP/1.1".
+
+TIP: When an error response is needed, consider using
+<<nng_http_res_alloc_error#,nng_http_res_alloc_error(3)>> instead.
+
+== RETURN VALUES
+
+This function returns 0 on success, and non-zero otherwise.
+
+== ERRORS
+
+`NNG_ENOMEM`:: Insufficient free memory exists to allocate a message.
+`NNG_ENOTSUP`:: HTTP support not configured.
+
+== SEE ALSO
+
+<<nng_http_conn_read_res#,nng_http_conn_read_res(3)>>,
+<<nng_http_conn_write_res#,nng_http_conn_write_res(3)>>,
+<<nng_http_req_alloc#,nng_http_req_alloc(3)>>,
+<<nng_http_res_alloc_errror#,nng_http_res_alloc_error(3)>>,
+<<nng_http_res_add_header#,nng_http_res_add_header(3)>>,
+<<nng_http_res_copy_data#,nng_http_res_copy_data(3)>>,
+<<nng_http_res_del_header#,nng_http_res_del_header(3)>>,
+<<nng_http_res_free#,nng_http_res_free(3)>>,
+<<nng_http_res_get_header#,nng_http_res_get_header(3)>>,
+<<nng_http_res_get_reason#,nng_http_res_get_reason(3)>>,
+<<nng_http_res_get_status#,nng_http_res_get_status(3)>>,
+<<nng_http_res_get_version#,nng_http_res_get_version(3)>>,
+<<nng_http_res_set_data#,nng_http_res_set_data(3)>>,
+<<nng_http_res_set_reason#,nng_http_res_set_reason(3)>>,
+<<nng_http_res_set_status#,nng_http_res_set_status(3)>>,
+<<nng_http_res_set_version#,nng_http_res_set_version(3)>>,
+<<nng_strerror#,nng_strerror(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].