aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_send_aio.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2019-07-06 13:33:55 -0700
committerGarrett D'Amore <garrett@damore.org>2019-07-06 13:33:55 -0700
commitdcb962389c5f71bc25cdb84f3363eed95bad9bdd (patch)
tree2a94b72596df4ff76081eb74632af0ce273517b1 /docs/man/nng_send_aio.3.adoc
parent7b6e73f23104a50b898da1065cf9d3bf8b6a3bca (diff)
downloadnng-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_send_aio.3.adoc')
-rw-r--r--docs/man/nng_send_aio.3.adoc38
1 files changed, 19 insertions, 19 deletions
diff --git a/docs/man/nng_send_aio.3.adoc b/docs/man/nng_send_aio.3.adoc
index ae6b6b7d..6ae66b17 100644
--- a/docs/man/nng_send_aio.3.adoc
+++ b/docs/man/nng_send_aio.3.adoc
@@ -24,15 +24,15 @@ void nng_send_aio(nng_socket s, nng_aio *aio);
== DESCRIPTION
-The `nng_send_aio()` sends a <<nng_msg.5#,message>> using the
-<<nng_socket.5#,socket>> _s_ asynchronously.
+The `nng_send_aio()` sends a xref:nng_msg.5.adoc[message] using the
+xref:nng_socket.5.adoc[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 xref:nng_aio_set_msg.3.adoc[`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 xref:nng_aio_result.3.adoc[`nng_aio_result()`]
will return zero. In this case the socket will dispose of the
message when it is finished with it.
@@ -45,22 +45,22 @@ 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()>>`
+xref:nng_aio_result.3.adoc[`nng_aio_result()`]
will return a non-zero error status.
In this case, the callback has a responsibility to retrieve the message from
the _aio_ with
-`<<nng_aio_get_msg.3#,nng_aio_get_msg()>>` and dispose of it appropriately.
+xref:nng_aio_get_msg.3.adoc[`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 xref:nng_msg_free.3.adoc[`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
+(For example, with a xref:nng_pub.7.adoc[_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.)
+xref:nng_recv.3.adoc[`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
+xref:nng_sub.7.adoc[_sub_]) or may require other conditions.
+(For example, xref:nng_rep.7.adoc[_rep_] sockets cannot normally send data, which
are responses to requests, until they have first received a request.)
== RETURN VALUES
@@ -81,11 +81,11 @@ None. (The operation completes asynchronously.)
== SEE ALSO
[.text-left]
-<<nng_aio_get_msg.3#,nng_aio_get_msg(3)>>,
-<<nng_aio_set_msg.3#,nng_aio_set_msg(3)>>,
-<<nng_msg_alloc.3#,nng_msg_alloc(3)>>,
-<<nng_strerror.3#,nng_strerror(3)>>,
-<<nng_aio.5#,nng_aio(5)>>,
-<<nng_msg.5#,nng_msg(5)>>,
-<<nng_socket.5#,nng_socket(5)>>,
-<<nng.7#,nng(7)>>
+xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg(3)],
+xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)],
+xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
+xref:nng_strerror.3.adoc[nng_strerror(3)],
+xref:nng_aio.5.adoc[nng_aio(5)],
+xref:nng_msg.5.adoc[nng_msg(5)],
+xref:nng_socket.5.adoc[nng_socket(5)],
+xref:nng.7.adoc[nng(7)]