From f241595500f989161c4b9f92389cf647ef94cfc0 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 26 Feb 2018 09:18:41 -0800 Subject: man page updates for 0.2.0 --- man/v0.2.0/nng_aio_alloc.html | 16 +++++++++++++++- man/v0.2.0/nng_recv.html | 6 +++--- man/v0.2.0/nng_send.html | 10 +++++----- 3 files changed, 23 insertions(+), 9 deletions(-) (limited to 'man') 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 callb, which will be executed when an associated asynchronous operation finishes. It will be called with the argument arg.

+
+ + + + + +
+ + +The callback callb must not perform any blocking operations, and +must complete it’s execution quickly. If callb does block, this can +lead ultimately to an apparent "hang" or deadlock in the application. +
+
-

Asynchronous I/O operations all take an "aio" handle such as allocated by +

Asynchronous I/O operations all take an aio 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 nng_send(3).

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 nng_req(3) socket a message may only be received -after a request has been sent, and an nng_sub(3) socket +example, with an nng_req(7) socket a message may only be received +after a request has been sent, and an nng_sub(7) 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 -nng_pub(3). +nng_pub(7). 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 s.

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(3) socket the data is broadcast, so that +example, with an nng_pub(7) socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using nng_recv(3) or a similar function.) Furthermore, some protocols -may not support sending data (such as nng_sub(3)) or may -require other conditions. (For example, nng_rep(3) sockets +may not support sending data (such as nng_sub(7)) or may +require other conditions. (For example, nng_rep(7) sockets cannot normally send data, which are responses to requests, until they have first received a request.) @@ -609,7 +609,7 @@ Regardless of the presence or absence of NNG_FLAG_NONBLOCK, 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 NNG_FLAG_NONBLOCK, such as with -nng_pub(3) sockets, which are best-effort delivery only. +nng_pub(7) sockets, which are best-effort delivery only. @@ -682,7 +682,7 @@ or transdimensional mutation of the program’s author.

nng_alloc(3), nng_free(3), -nng_recv(3), +nng_recv(3), nng_sendmsg(3), nng_strerror(3), nng(7)

-- cgit v1.2.3-70-g09d2