aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_send.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.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.3.adoc')
-rw-r--r--docs/man/nng_send.3.adoc32
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/man/nng_send.3.adoc b/docs/man/nng_send.3.adoc
index ef31cbbe..389ba079 100644
--- a/docs/man/nng_send.3.adoc
+++ b/docs/man/nng_send.3.adoc
@@ -25,16 +25,16 @@ int nng_send(nng_socket s, void *data, size_t size, int flags);
== DESCRIPTION
The `nng_send()` function sends a message containing the _data_ of
-length _size_ using the <<nng_socket.5#,socket>> _s_.
+length _size_ using the xref:nng_socket.5.adoc[socket] _s_.
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 an <<nng_pub.7#,_nng_>> socket the data is broadcast, so that
+(For example, with an xref:nng_pub.7.adoc[_nng_] 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 data (such as
-<<nng_sub.7#,_sub_>>) or may require other conditions.
-(For example, <<nng_rep.7#,_rep_>> sockets cannot normally send data,
+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 either of (or neither of) the following values:
@@ -48,12 +48,12 @@ The _flags_ may contain either of (or neither of) the following values:
then the function will block if such a condition exists.
`NNG_FLAG_ALLOC`::
- The _data_ was allocated using `<<nng_alloc.3#,nng_alloc()>>`, or was
- obtained from a call to `<<nng_recv.3#,nng_recv()>>` with
+ The _data_ was allocated using xref:nng_alloc.3.adoc[`nng_alloc()`], or was
+ obtained from a call to xref:nng_recv.3.adoc[`nng_recv()`] with
the `NNG_FLAG_ALLOC` flag.
If this function returns success, then the _data_ is "owned" by the
function, and it will assume responsibility for calling
- `<<nng_free.3#,nng_free()>>` when it is no longer needed.
+ xref:nng_free.3.adoc[`nng_free()`] when it is no longer needed.
In the absence of this flag, the _data_ is copied by the implementation
before the function returns to the caller.
@@ -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.
IMPORTANT: When using `NNG_FLAG_ALLOC`, it is important that the value of _size_
match the actual allocated size of the data.
@@ -91,10 +91,10 @@ This function returns 0 on success, and non-zero otherwise.
== SEE ALSO
[.text-left]
-<<nng_alloc.3#,nng_alloc(3)>>,
-<<nng_free.3#,nng_free(3)>>,
-<<nng_recv.3#,nng_recv(3)>>,
-<<nng_sendmsg.3#,nng_sendmsg(3)>>,
-<<nng_strerror.3#,nng_strerror(3)>>,
-<<nng_socket.5#,nng_socket(5)>>,
-<<nng.7#,nng(7)>>
+xref:nng_alloc.3.adoc[nng_alloc(3)],
+xref:nng_free.3.adoc[nng_free(3)],
+xref:nng_recv.3.adoc[nng_recv(3)],
+xref:nng_sendmsg.3.adoc[nng_sendmsg(3)],
+xref:nng_strerror.3.adoc[nng_strerror(3)],
+xref:nng_socket.5.adoc[nng_socket(5)],
+xref:nng.7.adoc[nng(7)]