From 87795b46f2bc732bd11067805709161bdc00d6b6 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Sun, 25 Feb 2018 17:56:55 -0800
Subject: More man page reorganization.

Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied.  So lets move them off into their own directory.
---
 docs/nng_http_client_connect.adoc | 96 ---------------------------------------
 1 file changed, 96 deletions(-)
 delete mode 100644 docs/nng_http_client_connect.adoc

(limited to 'docs/nng_http_client_connect.adoc')

diff --git a/docs/nng_http_client_connect.adoc b/docs/nng_http_client_connect.adoc
deleted file mode 100644
index f5fef4eb..00000000
--- a/docs/nng_http_client_connect.adoc
+++ /dev/null
@@ -1,96 +0,0 @@
-= nng_http_client_connect(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_connect - establish HTTP client connection
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-#include <nng/supplemental/http/http.h>
-
-void nng_http_client_connect(nng_http_client *client, nng_aio *aio);
------------
-
-== DESCRIPTION
-
-The `nng_http_client_connect()` starts the process of establishing an HTTP
-connection from _client_ to the server that was indicated in the URL that
-_client_ was configured with.
-
-The result of the operation will be stored in the _aio_ when the operation
-is complete, and will be obtainable via
-<<nng_aio_result#,nng_aio_result(3)>>.
-
-On success, a pointer to the underlying HTTP client (type `nng_http_conn *`)
-will be stored in the first output result of the _aio_, and can be
-obtained by
-<<nng_aio_get_output#,nng_aio_get_output(3)>> with an _index_ of zero (0).
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-`NNG_EADDRINVAL`:: The server is configured with an invalid address.
-`NNG_ECANCELED`:: The operation was aborted.
-`NNG_ECONNREFUSED`:: The TCP connection was refused by the server.
-`NNG_ECONNRESET`:: The TCP connection was reset by the server.
-`NNG_ENOMEM`:: Insufficient free memory exists.
-
-== EXAMPLE
-
-[source, c]
-----
-    nng_aio *aio;
-    nng_url *url;
-    nng_http_client *client;
-    nng_http_conn *conn;
-    int rv;
-
-    // Error checks elided for clarity.
-    nng_url_parse(&url, "http://www.google.com");
-    nng_aio_alloc(&aio, NULL, NULL);
-    nng_http_client_alloc(&client, url);
-
-    nng_http_client_connect(client, aio);
-
-    // Wait for connection to establish (or attempt to fail).
-    nng_aio_wait(aio);
-
-    if ((rv = nng_aio_result(aio)) != 0) {
-            printf("Connection failed: %s\n", nng_strerror(rv));
-    } else {
-            // Connection established, get it.
-            conn = nng_aio_get_output(aio, 0);
-
-            // ... do something with it here
-
-            // Close the connection when done to avoid leaking it.
-            nng_http_conn_close(conn);
-    }
-----
-
-== SEE ALSO
-
-<<nng_aio_get_output#,nng_aio_get_output(3)>>,
-<<nng_aio_result#,nng_aio_result(3)>>,
-<<nng_aio_wait#,nng_aio_wait(3)>>,
-<<nng_http_client_alloc#,nng_http_client_alloc(3)>>,
-<<nng_http_conn_close#,nng_http_conn_close(3)>>,
-<<nng_http_conn_read#,nng_http_conn_read(3)>>,
-<<nng_http_conn_write#,nng_http_conn_write(3)>>,
-<<nng_strerror#,nng_strerror(3)>>,
-<<nng#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2

