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_send_aio.3.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_send_aio.3.adoc')
| -rw-r--r-- | docs/man/nng_send_aio.3.adoc | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/man/nng_send_aio.3.adoc b/docs/man/nng_send_aio.3.adoc index bb110015..47f9df14 100644 --- a/docs/man/nng_send_aio.3.adoc +++ b/docs/man/nng_send_aio.3.adoc @@ -28,11 +28,11 @@ The `nng_send_aio()` sends a <<nng_msg.5#,message>> using the <<nng_socket.5#,socket>> _s_ asynchronously. The message to send must have previously been set on the _aio_ -using the <<nng_aio_set_msg.3#,`nng_aio_set_msg()`>> function. +using the `<<nng_aio_set_msg.3#,nng_aio_set_msg()>>` function. The function assumes "`ownership`" of the message. If the message was successfully queued for delivery to the socket, -then the _aio_ will be completed, and <<nng_aio_result.3#,`nng_aio_result()`>> +then the _aio_ will be completed, and `<<nng_aio_result.3#,nng_aio_result()>>` will return zero. In this case the socket will dispose of the message when it is finished with it. @@ -44,19 +44,20 @@ may still be buffered in the sending socket, buffered in the receiving socket, or in flight over physical media. If the operation fails for any reason (including cancellation or timeout), -then the _aio_ callback will be executed and <<nng_aio_result.3#,`nng_aio_result()`>> +then the _aio_ callback will be executed and +`<<nng_aio_result.3#,nng_aio_result()>>` will return a non-zero error status. In this case, the callback has a responsibity to retrieve the message from -the _aio_ with <<nng_aio_get_msg.3#,`nng_aio_get_msg()`>> and dispose of -it appropriately. +the _aio_ with +`<<nng_aio_get_msg.3#,nng_aio_get_msg()>>` and dispose of it appropriately. (This may include retrying the send operation on the same or a different -socket, or deallocating the message with <<nng_msg_free.3#,`nng_msg_free()`>>.) +socket, or deallocating the message with `<<nng_msg_free.3#,nng_msg_free()>>`.) NOTE: The semantics of what sending a message means varies from protocol to protocol, so examination of the protocol documentation is encouraged. (For example, with a <<nng_pub.7#,_pub_>> socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using -<<nng_recv.3#,`nng_recv()`>> or a similar function.) +`<<nng_recv.3#,nng_recv()>>` or a similar function.) Furthermore, some protocols may not support sending (such as <<nng_sub.7#,_sub_>>) or may require other conditions. (For example, <<nng_rep.7#,_rep_>> sockets cannot normally send data, which |
