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_recv_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_recv_aio.3.adoc')
| -rw-r--r-- | docs/man/nng_recv_aio.3.adoc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/man/nng_recv_aio.3.adoc b/docs/man/nng_recv_aio.3.adoc index 7e30996c..774577bf 100644 --- a/docs/man/nng_recv_aio.3.adoc +++ b/docs/man/nng_recv_aio.3.adoc @@ -29,9 +29,9 @@ The `nng_recv_aio()` receives a <<nng_msg.5#,message>> using the When a message is successfully received by the socket, it is stored in the _aio_ by an internal call equivalent to -<<nng_aio_set_msg.3#,`nng_aio_set_msg()`>>, then the completion +`<<nng_aio_set_msg.3#,nng_aio_set_msg()>>`, then the completion callback on the _aio_ is executed. -In this case, <<nng_aio_result.3#,`nng_aio_result()`>> will +In this case, `<<nng_aio_result.3#,nng_aio_result()>>` will return zero. The callback function is responsible for retrieving the message and disposing of it appropriately. @@ -42,13 +42,13 @@ case can lead to memory leaks. If for some reason the asynchronous receive cannot be completed successfully (including by being canceled or timing out), then the callback will still be executed, -but <<nng_aio_result.3#,`nng_aio_result()`>> will be non-zero. +but `<<nng_aio_result.3#,nng_aio_result()>>` will be non-zero. NOTE: The semantics of what receiving 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 receiving (such as <<nng_pub.7#,_pub_>>) or may require other conditions. (For example, <<nng_req.7#,_req_>> sockets cannot normally receive data, which |
