From fc0abbdf71700b2414ba012f9863f7dfaf514b91 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 2 Feb 2018 12:46:02 -0800 Subject: Document HTTP request/reply structures and handling. --- docs/nng_http_req_get_uri.adoc | 54 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 docs/nng_http_req_get_uri.adoc (limited to 'docs/nng_http_req_get_uri.adoc') diff --git a/docs/nng_http_req_get_uri.adoc b/docs/nng_http_req_get_uri.adoc new file mode 100644 index 00000000..982a28a1 --- /dev/null +++ b/docs/nng_http_req_get_uri.adoc @@ -0,0 +1,54 @@ += nng_http_req_get_method(3) +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:copyright: Copyright 2018 Staysail Systems, Inc. \ + Copyright 2018 Capitar IT Group BV \ + 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_get_uri - return HTTP request URI + +== SYNOPSIS + +[source, c] +----------- +#include + +const char *nng_http_req_get_method(nng_http_req *req); +----------- + +== DESCRIPTION + +The `nng_http_req_get_uri()` returns the URI (path) associated with the HTTP +the request _req_. The value returned includes the path, as well as any +query information or fragment. The value will look like a filesystem path +with those optional components appened, such as `/api/get_info.cgi?name=garrett`. + +== RETURN VALUES + +Request URI as a string. + +== ERRORS + +None. + +== SEE ALSO + +<>, +<>, +<> + + +== 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]. -- cgit v1.2.3-70-g09d2