aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_res_get_data.3http.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-08-30 14:23:39 -0700
committerGarrett D'Amore <garrett@damore.org>2018-08-30 15:28:43 -0700
commit0cc96c69b3fce09a9c4a8d467d17cfbda76bc02f (patch)
tree855f6995749e56f4a9e69ce7d19437b780d63ba2 /docs/man/nng_http_res_get_data.3http.adoc
parentc96b7665469679563ee642a42d175aa24a957f26 (diff)
downloadnng-0cc96c69b3fce09a9c4a8d467d17cfbda76bc02f.tar.gz
nng-0cc96c69b3fce09a9c4a8d467d17cfbda76bc02f.tar.bz2
nng-0cc96c69b3fce09a9c4a8d467d17cfbda76bc02f.zip
fixes #681 HTTP convenience GET method desired...
This adds a couple of new methods, and related documentation and test cases.
Diffstat (limited to 'docs/man/nng_http_res_get_data.3http.adoc')
-rw-r--r--docs/man/nng_http_res_get_data.3http.adoc50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/man/nng_http_res_get_data.3http.adoc b/docs/man/nng_http_res_get_data.3http.adoc
new file mode 100644
index 00000000..44f98c1f
--- /dev/null
+++ b/docs/man/nng_http_res_get_data.3http.adoc
@@ -0,0 +1,50 @@
+= nng_http_res_get_data(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_res_get_data - get HTTP response body
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+#include <nng/supplemental/http/http.h>
+
+void nng_http_res_get_data(nng_http_res *res, void **bodyp, size_t *sizep);
+----
+
+== DESCRIPTION
+
+The `nng_http_res_get_data()` gets the HTTP body associated with
+the request _res_, storing a pointer to the buffer at the location referenced
+by _bodyp_, and the length of the associated buffer at the location referenced
+by _sizep_.
+
+NOTE: The buffer returned is owned by _res_, and will automatically freed
+when the request is freed.
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+<<nng_http_res_alloc.3http#,nng_http_req_alloc(3http)>>,
+<<nng_http_res_set_data.3http#,nng_http_req_copy_data(3http)>>,
+<<nng_http_res_copy_data.3http#,nng_http_req_copy_data(3http)>>,
+<<nng.7#,nng(7)>>