Document HTTP request/reply structures and handling.

1 files changed, 64 insertions, 0 deletions

diff --git a/docs/nng_http_req_set_uri.adoc b/docs/nng_http_req_set_uri.adoc
new file mode 100644
index 00000000..3208958a
--- /dev/null
+++ b/docs/nng_http_req_set_uri.adoc
@@ -0,0 +1,64 @@
+= nng_http_req_set_uri(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_set_uri - set HTTP request URI
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_http_req_set_uri(nng_http_req *req, const char *uri);
+-----------
+
+== DESCRIPTION
+
+The `nng_http_req_set_uri()` sets the Request-URI associated with
+the request _req_ to _uri_.  The _uri_ should contain precisely the
+string that will be sent to the HTTP server in the request, including
+any query information or fragment.
+
+A local copy of the _uri_ is made in the request _req_.
+
+NOTE: No validation or canonicalization of the _uri_ is performed.
+
+TIP: The <<nng_url_parse#,nng_url_parse(3)>> function can be used to
+perform validation and canonicalization.  The `u_requri` member will
+contain a suitable value that can be used with this function.
+
+== 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_req_alloc#,nng_http_req_alloc(3)>>,
+<<nng_http_req_get_uri#,nng_http_req_get_uri(3)>>,
+<<nng_url_parse#,nng_url_parse(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].