aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_res_get_version.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-02 12:46:02 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-02 12:46:02 -0800
commitfc0abbdf71700b2414ba012f9863f7dfaf514b91 (patch)
tree16fca800dbce3abf42f4013cfb0ca4b8aed3981f /docs/nng_http_res_get_version.adoc
parent490bc97dbf76fae2a99c8bacd5fd9be332d68b90 (diff)
downloadnng-fc0abbdf71700b2414ba012f9863f7dfaf514b91.tar.gz
nng-fc0abbdf71700b2414ba012f9863f7dfaf514b91.tar.bz2
nng-fc0abbdf71700b2414ba012f9863f7dfaf514b91.zip
Document HTTP request/reply structures and handling.
Diffstat (limited to 'docs/nng_http_res_get_version.adoc')
-rw-r--r--docs/nng_http_res_get_version.adoc53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/nng_http_res_get_version.adoc b/docs/nng_http_res_get_version.adoc
new file mode 100644
index 00000000..740dd661
--- /dev/null
+++ b/docs/nng_http_res_get_version.adoc
@@ -0,0 +1,53 @@
+= nng_http_res_get_version(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_get_version - return HTTP response protocol version
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+const char *nng_http_res_get_version(nng_http_res *res);
+-----------
+
+== DESCRIPTION
+
+The `nng_http_res_get_version()` returns a string representing the HTTP
+protocol version associated with the request _res_, such as "HTTP/1.1".
+
+
+== RETURN VALUES
+
+Response version as a string.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+<<nng_http_res_alloc#,nng_http_res_alloc(3)>>,
+<<nng_http_res_set_version#,nng_http_res_set_version(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].