aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_client_alloc.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-07 13:59:11 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-07 14:00:27 -0800
commit03447b4532e12df48ab117c7433786334b8aeff7 (patch)
treea6f1f894a6fac6eaf626a528e9c95851c7b42129 /docs/nng_http_client_alloc.adoc
parent0fe0f3e744f19e81ae559315ff2b422158fb6329 (diff)
downloadnng-03447b4532e12df48ab117c7433786334b8aeff7.tar.gz
nng-03447b4532e12df48ab117c7433786334b8aeff7.tar.bz2
nng-03447b4532e12df48ab117c7433786334b8aeff7.zip
Add documentation for HTTP client API.
Diffstat (limited to 'docs/nng_http_client_alloc.adoc')
-rw-r--r--docs/nng_http_client_alloc.adoc51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/nng_http_client_alloc.adoc b/docs/nng_http_client_alloc.adoc
new file mode 100644
index 00000000..32b30ce5
--- /dev/null
+++ b/docs/nng_http_client_alloc.adoc
@@ -0,0 +1,51 @@
+= nng_http_client_alloc(3)
+:doctype: manpage
+:manmanual: nng
+:mansource: nng
+:manvolnum: 3
+:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
+ Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
+ {blank} + \
+ This document is supplied under the terms of the \
+ https://opensource.org/licenses/MIT[MIT License].
+
+== NAME
+
+nng_http_client_alloc - allocate HTTP client
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_http_client_alloc(nng_http_client *clientp, const nng_url *url);
+-----------
+
+
+== DESCRIPTION
+
+The `nng_http_client_alloc()` allocates an HTTP client suitable for
+connecting to the server identifyed by _url_ and stores a pointer to
+it in the location referenced by _clientp_.
+
+== RETURN VALUES
+
+This function returns 0 on success, and non-zero otherwise.
+
+== ERRORS
+
+`NNG_ENOMEM`:: Insufficient free memory exists.
+`NNG_ENOTSUP`:: HTTP not supported.
+
+== SEE ALSO
+
+<<nng_http_client_connect#,nng_http_client_connect(3)>>,
+<<nng_http_client_free#,nng_http_client_free(3)>>,
+<<nng_url_parse#,nng_url_parse(3)>>
+<<nng_strerror#,nng_strerror(3)>>,
+<<nng#,nng(7)>>
+
+== COPYRIGHT
+
+{copyright}