3party/libzmq
0
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2025-03-09 23:36:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation for zmq_close and zmq_term fixed.

Browse Source 
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
This commit is contained in:
Martin Sustrik 2010-10-30 18:17:53 +02:00
parent 3d8eb071a2
commit 085b709021
2 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/zmq_close.txt
View File

@ -15,12 +15,11 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
----------- -----------
The _zmq_close()_ function shall destroy the socket referenced by the 'socket' The _zmq_close()_ function shall destroy the socket referenced by the 'socket'
argument. All active connections on the socket shall be terminated and argument. Any outstanding messages physically received from the network but not
resources associated with the socket shall be released. Any outstanding yet received by the application with _zmq_recv()_ shall also be dropped. As for
messages sent with _zmq_send()_ but not yet physically sent to the network the messages sent with _zmq_send()_ but not yet passed to the network, 0MQ
shall be dropped. Likewise, any outstanding messages physically received from will try to send them in the background after _zmq_close()_ returns. Time spent
the network but not yet received by the application with _zmq_recv()_ shall attempting can be set using _ZMQ_LINGER_ socket option.
also be dropped.
RETURN VALUE RETURN VALUE
@ -39,6 +38,7 @@ SEE ALSO
-------- --------
linkzmq:zmq_socket[3] linkzmq:zmq_socket[3]
linkzmq:zmq_term[3] linkzmq:zmq_term[3]
linkzmq:zmq_setsockopt[3]
linkzmq:zmq[7] linkzmq:zmq[7]

21
doc/zmq_term.txt
View File

@ -16,23 +16,18 @@ DESCRIPTION
----------- -----------
The _zmq_term()_ function terminates the 0MQ context 'context'. The _zmq_term()_ function terminates the 0MQ context 'context'.
If there are no longer any sockets open within 'context' at the time It does so in following steps:
_zmq_term()_ is called then 'context' shall be shut down and all associated
resources shall be released immediately.
Otherwise, the following applies: * It causes any blocking operations currently in progress on sockets open within
'context' to exit immediately with an error code of ETERM.
* 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.
* With the exception of _zmq_close()_, any further operations on sockets open * With the exception of _zmq_close()_, any further operations on sockets open
within 'context' shall fail with an error code of ETERM. within 'context' shall fail with an error code of ETERM.
* The actual shutdown of 'context', and release of any associated resources, * After iterrupting all blocking calls, _zmq_term()_ blocks until all sockets
*shall be delayed* until the last socket within it is closed with open within the context are closed using _zmq_close()_ and either all the
_zmq_close()_. pending outbound messages are pushed to the network or ZMQ_LINGER period
expires for individual sockets.
RETURN VALUE RETURN VALUE
@ -51,6 +46,8 @@ SEE ALSO
-------- --------
linkzmq:zmq[7] linkzmq:zmq[7]
linkzmq:zmq_init[3] linkzmq:zmq_init[3]
linkzmq:zmq_close[3]
linkzmq:zmq_setsockopt[3]
AUTHORS AUTHORS