summaryrefslogtreecommitdiff
path: root/doc/zmq_close.txt
diff options
context:
space:
mode:
authorMartin Lucina <mato@kotelna.sk>2010-12-01 10:57:37 +0100
committerMartin Sustrik <sustrik@250bpm.com>2010-12-01 10:57:37 +0100
commitb70d628fad5ab97d24473b83fd18997b4e87477d (patch)
tree71d2556da535ece2407db7f983a30cf7a04419dc /doc/zmq_close.txt
parent5bb0a339be31064900257e04e2ffd32e80911d63 (diff)
Documentation updates for 2.1
- Clarify ZMQ_LINGER, zmq_close (), zmq_term () relationship - New socket options - Clarify thread safety of sockets and migration between threads - Other minor and spelling fixes Signed-off-by: Martin Lucina <mato@kotelna.sk>
Diffstat (limited to 'doc/zmq_close.txt')
-rw-r--r--doc/zmq_close.txt12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/zmq_close.txt b/doc/zmq_close.txt
index 1200fb7..fe3bde5 100644
--- a/doc/zmq_close.txt
+++ b/doc/zmq_close.txt
@@ -16,10 +16,14 @@ DESCRIPTION
-----------
The _zmq_close()_ function shall destroy the socket referenced by the 'socket'
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.
+yet received by the application with _zmq_recv()_ shall be discarded. The
+behaviour for discarding messages sent by the application with _zmq_send()_ but
+not yet physically transferred to the network depends on the value of the
+_ZMQ_LINGER_ socket option for the specified 'socket'.
+
+NOTE: The default setting of _ZMQ_LINGER_ does not discard unsent messages;
+this behaviour may cause the application to block when calling _zmq_term()_.
+For details refer to linkzmq:zmq_setsockopt[3] and linkzmq:zmq_term[3].
RETURN VALUE