diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-01 17:11:32 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-01 19:18:37 -0700 |
| commit | 3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c (patch) | |
| tree | d670fc9ac327e017c62a72cbaeda4bcacda5f9dd /docs/man/nng_http_conn_read_all.3http.adoc | |
| parent | 1ef281a7fbd544c6d3384fd8a71d10dc4bb081e8 (diff) | |
| download | nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.gz nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.bz2 nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.zip | |
Markup fixes, ensuring links are colored properly.
It turns out that when creating cross references, we need to
make any text styling (generally literal characters) outside of
the link, to avoid having the styling override the link color.
(We prefer to have links colored for ease of use.)
While here a few other markup, and actual content, errors were fixed.
Diffstat (limited to 'docs/man/nng_http_conn_read_all.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_conn_read_all.3http.adoc | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/man/nng_http_conn_read_all.3http.adoc b/docs/man/nng_http_conn_read_all.3http.adoc index 78a89a13..0a8140fd 100644 --- a/docs/man/nng_http_conn_read_all.3http.adoc +++ b/docs/man/nng_http_conn_read_all.3http.adoc @@ -29,21 +29,22 @@ 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.3#,`nng_aio_set_iov()`>> function must have been +NOTE: The `<<nng_aio_set_iov.3#,nng_aio_set_iov()>>` 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.3#,`nng_aio_result()`>>. That result will -either be zero or an error code. +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.3#,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 +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.3#,`nng_aio_count()`>>. +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.3#,nng_aio_count()>>`. TIP: The main purpose for this function is to faciliate reading HTTP body content, after first determining the length of the body content |
