aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_http_conn_read_all.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-15 08:40:17 -0700
committerGarrett D'Amore <garrett@damore.org>2018-03-17 08:49:12 -0700
commit98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch)
treee3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_http_conn_read_all.adoc
parent91866ed9365ab89069c12da41c873c23d0ba1d19 (diff)
downloadnng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.gz
nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.bz2
nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.zip
fixes #286 nng_pair0_open (and all others) need man page
fixes #279 consider restructuring man sections This represents a rather significant rework, and major editing effort, for the entire set of manual pages. All of the pages now have a section number in their filename; this assists in some other tooling, particularly ebook generation as every link needs to be programmatically modified when combined into an ebook. Section 5 is introduced, and populated with pages for the main types, and all options are now documented. Numerous errors have been corrected, including rewriting certain portions such as the header section of the surveyor protocol. Much work has been done to facilitate index generation, although certainly more work remains here. Every internal link within these pages now resolves; there are no more dead links. (This is required to generate Kindle format books.)
Diffstat (limited to 'docs/man/nng_http_conn_read_all.adoc')
-rw-r--r--docs/man/nng_http_conn_read_all.adoc75
1 files changed, 0 insertions, 75 deletions
diff --git a/docs/man/nng_http_conn_read_all.adoc b/docs/man/nng_http_conn_read_all.adoc
deleted file mode 100644
index f98eedd5..00000000
--- a/docs/man/nng_http_conn_read_all.adoc
+++ /dev/null
@@ -1,75 +0,0 @@
-= nng_http_conn_read_all(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_conn_read_all - read all from HTTP connection
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-#include <nng/supplemental/http/http.h>
-
-void nng_http_conn_read_all(nng_http_conn *conn, nng_aio *aio);
------------
-
-== DESCRIPTION
-
-The `nng_http_conn_read_all()` function starts an asynchronous read from the
-HTTP connection _conn_, into the scatter/gather vector located in the
-asynchronous I/O structure _aio_.
-
-NOTE: The <<nng_aio_set_iov#,nng_aio_set_iov(3)>> function must have been
-called first, to set the scatter/gather vector for _aio_.
-
-This function returns immediately, with no return value. Completion of
-the operation is signaled via the _aio_, and the final result may be
-obtained via <<nng_aio_result#,nng_aio_result(3)>>. That result will
-either be zero or an error code.
-
-The I/O operation completes only when the entire amount of data
-requested has been read, or an error has occurred. If the operation
-completes successfully, then the entire requested data has been read.
-
-It is still possible for a partial read to complete in the event of an
-error. The actual number of bytes read can be determined with
-<<nng_aio_count#,nng_aio_count(3)>>.
-
-TIP: The main purpose for this function is to faciliate reading HTTP
-body content, after first determining the length of the body content
-from the relevant HTTP headers (typically `Content-Length`).
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-`NNG_ECANCELED`:: The operation was canceled.
-`NNG_ECLOSED`:: The connection was closed.
-`NNG_ECONNRESET`:: The peer closed the connection.
-`NNG_EINVAL`:: The _aio_ does not contain a valid scatter/gather vector.
-`NNG_ENOMEM`:: Insufficient free memory to perform the operation.
-`NNG_ENOTSUP`:: HTTP operations are not supported.
-`NNG_ETIMEDOUT`:: Timeout waiting for data from the connection.
-
-== SEE ALSO
-
-<<nng_aio_alloc#,nng_aio_alloc(3)>>,
-<<nng_aio_count#,nng_aio_count(3)>>,
-<<nng_aio_result#,nng_aio_result(3)>>,
-<<nng_aio_set_iov#,nng_aio_set_iov(3)>>,
-<<nng_http_client_connect#,nng_http_client_connect(3)>>,
-<<nng_http_conn_read#,nng_http_conn_read(3)>>,
-<<nng_strerror#,nng_strerror(3)>>,
-<<nng#,nng(7)>>