diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_http_conn_read_all.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
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.
Diffstat (limited to 'docs/nng_http_conn_read_all.adoc')
| -rw-r--r-- | docs/nng_http_conn_read_all.adoc | 76 |
1 files changed, 0 insertions, 76 deletions
diff --git a/docs/nng_http_conn_read_all.adoc b/docs/nng_http_conn_read_all.adoc deleted file mode 100644 index e5f89389..00000000 --- a/docs/nng_http_conn_read_all.adoc +++ /dev/null @@ -1,76 +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>>. 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_alloc_handler#,nng_http_alloc_handler(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)>> |
