diff options
| author | Garrett D'Amore <garrett@damore.org> | 2019-07-06 13:33:55 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-07-06 13:33:55 -0700 |
| commit | dcb962389c5f71bc25cdb84f3363eed95bad9bdd (patch) | |
| tree | 2a94b72596df4ff76081eb74632af0ce273517b1 /docs/man/nng_http_conn_read.3http.adoc | |
| parent | 7b6e73f23104a50b898da1065cf9d3bf8b6a3bca (diff) | |
| download | nng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.tar.gz nng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.tar.bz2 nng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.zip | |
fixes #861 Man pages need to use .adoc suffix
Diffstat (limited to 'docs/man/nng_http_conn_read.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_conn_read.3http.adoc | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/man/nng_http_conn_read.3http.adoc b/docs/man/nng_http_conn_read.3http.adoc index 671af4aa..dfb6e08c 100644 --- a/docs/man/nng_http_conn_read.3http.adoc +++ b/docs/man/nng_http_conn_read.3http.adoc @@ -29,20 +29,20 @@ The `nng_http_conn_read()` 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 xref:nng_aio_set_iov.3.adoc[`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()>>`. +xref:nng_aio_result.3.adoc[`nng_aio_result()`]. That result will either be zero or an error code. The I/O operation completes as soon as at least one byte has been read, or an error has occurred. Therefore, the number of bytes read may be less than requested. The actual number of bytes read can be determined with -`<<nng_aio_count.3#,nng_aio_count()>>`. +xref:nng_aio_count.3.adoc[`nng_aio_count()`]. TIP: This function is intended to facilitate uses cases that involve changing the protocol from HTTP, such as WebSocket. @@ -66,12 +66,12 @@ None. == SEE ALSO [.text-left] -<<nng_aio_alloc.3#,nng_aio_alloc(3)>>, -<<nng_aio_count.3#,nng_aio_count(3)>>, -<<nng_aio_result.3#,nng_aio_result(3)>>, -<<nng_aio_set_iov.3#,nng_aio_set_iov(3)>>, -<<nng_http_handler_alloc.3http#,nng_http_handler_alloc(3http)>>, -<<nng_http_client_connect.3http#,nng_http_client_connect(3http)>>, -<<nng_http_conn_read_all.3http#,nng_http_conn_read_all(3http)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng.7#,nng(7)>> +xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)], +xref:nng_aio_count.3.adoc[nng_aio_count(3)], +xref:nng_aio_result.3.adoc[nng_aio_result(3)], +xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)], +xref:nng_http_handler_alloc.3http.adoc[nng_http_handler_alloc(3http)], +xref:nng_http_client_connect.3http.adoc[nng_http_client_connect(3http)], +xref:nng_http_conn_read_all.3http.adoc[nng_http_conn_read_all(3http)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng.7.adoc[nng(7)] |