diff options
Diffstat (limited to 'docs/man/nng_http_client_alloc.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_client_alloc.3http.adoc | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/man/nng_http_client_alloc.3http.adoc b/docs/man/nng_http_client_alloc.3http.adoc new file mode 100644 index 00000000..f6fa2862 --- /dev/null +++ b/docs/man/nng_http_client_alloc.3http.adoc @@ -0,0 +1,47 @@ += nng_http_client_alloc(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_client_alloc - allocate HTTP client + +== SYNOPSIS + +[source, c] +----------- +#include <nng/nng.h> +#include <nng/supplemental/http/http.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.3http#,nng_http_client_connect(3http)>>, +<<nng_http_client_free.3http#,nng_http_client_free(3http)>>, +<<nng_strerror.3#,nng_strerror(3)>>, +<<nng_url_parse.3#,nng_url_parse(3)>>, +<<nng.7#,nng(7)>> |