aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_http_client_alloc.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nng_http_client_alloc.adoc')
-rw-r--r--docs/nng_http_client_alloc.adoc47
1 files changed, 0 insertions, 47 deletions
diff --git a/docs/nng_http_client_alloc.adoc b/docs/nng_http_client_alloc.adoc
deleted file mode 100644
index 40499862..00000000
--- a/docs/nng_http_client_alloc.adoc
+++ /dev/null
@@ -1,47 +0,0 @@
-= nng_http_client_alloc(3)
-//
-// 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#,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)>>