From d0a26bbd1caf3de2132855d7936fed8ac1f1488c Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 7 Jan 2019 23:14:51 -0800 Subject: fixes #858 Document the TLS public API This also includes a number of the documentation improvements. The options document has been broken up into separate pages for each of the transport specific options. We have made various other minor improvements, fixes to markup, and cross-references. --- docs/man/nng_tcp_send.3tcp.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/man/nng_tcp_send.3tcp.adoc') diff --git a/docs/man/nng_tcp_send.3tcp.adoc b/docs/man/nng_tcp_send.3tcp.adoc index 723781d5..806dd9c0 100644 --- a/docs/man/nng_tcp_send.3tcp.adoc +++ b/docs/man/nng_tcp_send.3tcp.adoc @@ -29,19 +29,19 @@ The `nng_tcp_send()` function starts an asynchronous send over the TCP connection _conn_ from the scatter/gather vector located in the asynchronous I/O structure _aio_. -NOTE: The `<>` function must have been +NOTE: The <> 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 `<>`. +result may be obtained via <>. That result will either be zero or an error code. The I/O operation completes as soon as at least one byte has been sent, or an error has occurred. Therefore, the number of bytes sent may be less than requested. The actual number of bytes sent can be determined with -`<>`. +<>. NOTE: While TCP has the notion of urgent (out-of-band) delivery, that is used by very few protocols and this API does not support it. -- cgit v1.2.3-70-g09d2