summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-26 09:18:41 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-26 09:18:41 -0800
commitf241595500f989161c4b9f92389cf647ef94cfc0 (patch)
tree35a6550faf2df2899acbe0463609d4717e870224 /man
parente552404adef007d9a7052976cad5a511220acaf5 (diff)
downloadnng-f241595500f989161c4b9f92389cf647ef94cfc0.tar.gz
nng-f241595500f989161c4b9f92389cf647ef94cfc0.tar.bz2
nng-f241595500f989161c4b9f92389cf647ef94cfc0.zip
man page updates for 0.2.0
Diffstat (limited to 'man')
-rw-r--r--man/v0.2.0/nng_aio_alloc.html16
-rw-r--r--man/v0.2.0/nng_recv.html6
-rw-r--r--man/v0.2.0/nng_send.html10
3 files changed, 23 insertions, 9 deletions
diff --git a/man/v0.2.0/nng_aio_alloc.html b/man/v0.2.0/nng_aio_alloc.html
index fa4da8d8..2a542b7b 100644
--- a/man/v0.2.0/nng_aio_alloc.html
+++ b/man/v0.2.0/nng_aio_alloc.html
@@ -542,8 +542,22 @@ with a completion callback of <em>callb</em>, which will be executed when an
associated asynchronous operation finishes. It will be called with the
argument <em>arg</em>.</p>
</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+The callback <em>callb</em> must not perform any blocking operations, and
+must complete it&#8217;s execution quickly. If <em>callb</em> does block, this can
+lead ultimately to an apparent "hang" or deadlock in the application.
+</td>
+</tr>
+</table>
+</div>
<div class="paragraph">
-<p>Asynchronous I/O operations all take an "aio" handle such as allocated by
+<p>Asynchronous I/O operations all take an <em>aio</em> handle such as allocated by
this function. Such operations are usually started by a function that returns
immediately. The operation is then run asynchronously, and completes sometime
later. When that operation is complete, the callback supplied here is called,
diff --git a/man/v0.2.0/nng_recv.html b/man/v0.2.0/nng_recv.html
index 07c038a9..ab999174 100644
--- a/man/v0.2.0/nng_recv.html
+++ b/man/v0.2.0/nng_recv.html
@@ -566,11 +566,11 @@ size) via <a href="nng_send.html">nng_send(3)</a>.</p>
<td class="content">
The semantics of what receiving a message means vary from protocol to
protocol, so examination of the protocol documentation is encouraged. (For
-example, with an <a href="nng_req.html">nng_req(3)</a> socket a message may only be received
-after a request has been sent, and an <a href="nng_sub.html">nng_sub(3)</a> socket
+example, with an <a href="nng_req.html">nng_req(7)</a> socket a message may only be received
+after a request has been sent, and an <a href="nng_sub.html">nng_sub(7)</a> socket
may only receive messages corresponding to topics to which it has subscribed.)
Furthermore, some protocols may not support receiving data at all, such as
-<a href="nng_pub.html">nng_pub(3)</a>.
+<a href="nng_pub.html">nng_pub(7)</a>.
</td>
</tr>
</table>
diff --git a/man/v0.2.0/nng_send.html b/man/v0.2.0/nng_send.html
index ee525039..7bec110e 100644
--- a/man/v0.2.0/nng_send.html
+++ b/man/v0.2.0/nng_send.html
@@ -548,11 +548,11 @@ using the socket <em>s</em>.</p>
<td class="content">
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 <a href="nng_pub.html">nng_pub(3)</a> socket the data is broadcast, so that
+example, with an <a href="nng_pub.html">nng_pub(7)</a> socket the data is broadcast, so that
any peers who have a suitable subscription will be able to receive it using
<a href="nng_recv.html">nng_recv(3)</a> or a similar function.) Furthermore, some protocols
-may not support sending data (such as <a href="nng_sub.html">nng_sub(3)</a>) or may
-require other conditions. (For example, <a href="nng_rep.html">nng_rep(3)</a> sockets
+may not support sending data (such as <a href="nng_sub.html">nng_sub(7)</a>) or may
+require other conditions. (For example, <a href="nng_rep.html">nng_rep(7)</a> sockets
cannot normally send data, which are responses to requests, until they have
first received a request.)
</td>
@@ -609,7 +609,7 @@ Regardless of the presence or absence of <code>NNG_FLAG_NONBLOCK</code>, there m
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 implictly <code>NNG_FLAG_NONBLOCK</code>, such as with
-<a href="nng_pub.html">nng_pub(3)</a> sockets, which are best-effort delivery only.
+<a href="nng_pub.html">nng_pub(7)</a> sockets, which are best-effort delivery only.
</td>
</tr>
</table>
@@ -682,7 +682,7 @@ or transdimensional mutation of the program&#8217;s author.
<div class="paragraph">
<p><a href="nng_alloc.html">nng_alloc(3)</a>,
<a href="nng_free.html">nng_free(3)</a>,
-<a href="#nng_recv">nng_recv(3)</a>,
+<a href="nng_recv.html">nng_recv(3)</a>,
<a href="nng_sendmsg.html">nng_sendmsg(3)</a>,
<a href="nng_strerror.html">nng_strerror(3)</a>,
<a href="nng.html">nng(7)</a></p>