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_sendmsg.3.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_sendmsg.3.adoc')
| -rw-r--r-- | docs/man/nng_sendmsg.3.adoc | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/man/nng_sendmsg.3.adoc b/docs/man/nng_sendmsg.3.adoc index 10b8d370..1fe46d42 100644 --- a/docs/man/nng_sendmsg.3.adoc +++ b/docs/man/nng_sendmsg.3.adoc @@ -36,16 +36,16 @@ to dispose of the _msg_, which may include freeing it, sending it to another socket, or simply trying again later. TIP: Using this function gives access to the message structure, and may -offer more functionality than the simpler `<<nng_send.3#,nng_send()>>` function. +offer more functionality than the simpler xref:nng_send.3.adoc[`nng_send()`] function. NOTE: The semantics of what sending a message means vary 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.) The _flags_ may contain the following value: @@ -64,7 +64,7 @@ NOTE: Regardless of the presence or absence of `NNG_FLAG_NONBLOCK`, there may be queues between the sender and the receiver. Furthermore, there is no guarantee that the message has actually been delivered. Finally, with some protocols, the semantic is implicitly `NNG_FLAG_NONBLOCK`, -such as with <<nng_pub.7#,_pub_>> sockets, which are best-effort delivery only. +such as with xref:nng_pub.7.adoc[_pub_] sockets, which are best-effort delivery only. == RETURN VALUES @@ -85,10 +85,10 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_msg_alloc.3#,nng_msg_alloc(3)>>, -<<nng_recvmsg.3#,nng_recvmsg(3)>>, -<<nng_send.3#,nng_send(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_msg.5#,nng_msg(5)>>, -<<nng_socket.5#,nng_socket(5)>>, -<<nng.7#,nng(7)>> +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_recvmsg.3.adoc[nng_recvmsg(3)], +xref:nng_send.3.adoc[nng_send(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] |
