aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_req_reset.3http.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-09-12 12:48:13 -0700
committerGarrett D'Amore <garrett@damore.org>2018-09-12 12:51:31 -0700
commit0863d12e2b5173efeb074cbc9fa05f26274f126b (patch)
tree2b4b137aa4d85d681fe0bc5118a22155cb691536 /docs/man/nng_http_req_reset.3http.adoc
parent5f73996bf368e7f5d7249679c738a87873cb340d (diff)
downloadnng-0863d12e2b5173efeb074cbc9fa05f26274f126b.tar.gz
nng-0863d12e2b5173efeb074cbc9fa05f26274f126b.tar.bz2
nng-0863d12e2b5173efeb074cbc9fa05f26274f126b.zip
fixes #717 need nng_http_req_reset and nng_http_res_reset
fixes #718 http_transact is still not right fixes #719 calculation of buffer size is incorrect in http
Diffstat (limited to 'docs/man/nng_http_req_reset.3http.adoc')
-rw-r--r--docs/man/nng_http_req_reset.3http.adoc48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/man/nng_http_req_reset.3http.adoc b/docs/man/nng_http_req_reset.3http.adoc
new file mode 100644
index 00000000..9aab704a
--- /dev/null
+++ b/docs/man/nng_http_req_reset.3http.adoc
@@ -0,0 +1,48 @@
+= nng_http_req_reset(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_req_reset - reset HTTP request structure
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+#include <nng/supplemental/http/http.h>
+
+void nng_http_req_reset(nng_http_req *req);
+----
+
+== DESCRIPTION
+
+The `nng_http_req_reset()` function resets the request __req__ so that it
+is just as if it had been freshly allocated with
+`<<nng_http_req_alloc.3http#,nng_http_req_alloc()>>` with a `NULL` URL.
+
+NOTE: Before using this with an HTTP operation, the URI must be set using
+`<<nng_http_req_set_uri.3http#,nng_http_req_set_uri()>>`.
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+<<nng_http_req_alloc.3http#,nng_http_req_alloc(3http)>>,
+<<nng_http_req_set_uri.3http#,nng_http_req_set_uri(3http)>>,
+<<nng.7#,nng(7)>>