summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Sustrik <sustrik@250bpm.com>2010-10-30 18:17:53 +0200
committerMartin Sustrik <sustrik@250bpm.com>2010-10-30 18:17:53 +0200
commit085b709021c44673d9bf65a5d639e3c2e99703af (patch)
tree453dccdc55c492141cf450e0249ef410cdf85113
parent3d8eb071a2a664d8de1e2e2fa7cb46a4f2764e5e (diff)
Documentation for zmq_close and zmq_term fixed.
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
-rw-r--r--doc/zmq_close.txt12
-rw-r--r--doc/zmq_term.txt21
2 files changed, 15 insertions, 18 deletions
diff --git a/doc/zmq_close.txt b/doc/zmq_close.txt
index e903437..1200fb7 100644
--- a/doc/zmq_close.txt
+++ b/doc/zmq_close.txt
@@ -15,12 +15,11 @@ SYNOPSIS
DESCRIPTION
-----------
The _zmq_close()_ function shall destroy the socket referenced by the 'socket'
-argument. All active connections on the socket shall be terminated and
-resources associated with the socket shall be released. Any outstanding
-messages sent with _zmq_send()_ but not yet physically sent to the network
-shall be dropped. Likewise, any outstanding messages physically received from
-the network but not yet received by the application with _zmq_recv()_ shall
-also be dropped.
+argument. Any outstanding messages physically received from the network but not
+yet received by the application with _zmq_recv()_ shall also be dropped. As for
+the messages sent with _zmq_send()_ but not yet passed to the network, 0MQ
+will try to send them in the background after _zmq_close()_ returns. Time spent
+attempting can be set using _ZMQ_LINGER_ socket option.
RETURN VALUE
@@ -39,6 +38,7 @@ SEE ALSO
--------
linkzmq:zmq_socket[3]
linkzmq:zmq_term[3]
+linkzmq:zmq_setsockopt[3]
linkzmq:zmq[7]
diff --git a/doc/zmq_term.txt b/doc/zmq_term.txt
index f3ffa01..6c69b82 100644
--- a/doc/zmq_term.txt
+++ b/doc/zmq_term.txt
@@ -16,23 +16,18 @@ DESCRIPTION
-----------
The _zmq_term()_ function terminates the 0MQ context 'context'.
-If there are no longer any sockets open within 'context' at the time
-_zmq_term()_ is called then 'context' shall be shut down and all associated
-resources shall be released immediately.
+It does so in following steps:
-Otherwise, the following applies:
-
-* The _zmq_term()_ function shall return immediately.
-
-* Any blocking operations currently in progress on sockets open within
- 'context' shall return immediately with an error code of ETERM.
+* It causes any blocking operations currently in progress on sockets open within
+ 'context' to exit immediately with an error code of ETERM.
* With the exception of _zmq_close()_, any further operations on sockets open
within 'context' shall fail with an error code of ETERM.
-* The actual shutdown of 'context', and release of any associated resources,
- *shall be delayed* until the last socket within it is closed with
- _zmq_close()_.
+* After iterrupting all blocking calls, _zmq_term()_ blocks until all sockets
+ open within the context are closed using _zmq_close()_ and either all the
+ pending outbound messages are pushed to the network or ZMQ_LINGER period
+ expires for individual sockets.
RETURN VALUE
@@ -51,6 +46,8 @@ SEE ALSO
--------
linkzmq:zmq[7]
linkzmq:zmq_init[3]
+linkzmq:zmq_close[3]
+linkzmq:zmq_setsockopt[3]
AUTHORS