libzmq/doc/zmq_term.txt
Martin Sustrik 085b709021 Documentation for zmq_close and zmq_term fixed.
Signed-off-by: Martin Sustrik <sustrik@250bpm.com>
2010-10-30 18:17:53 +02:00

57 lines
1.2 KiB
Plaintext

zmq_term(3)
===========
NAME
----
zmq_term - terminate 0MQ context
SYNOPSIS
--------
*int zmq_term (void '*context');*
DESCRIPTION
-----------
The _zmq_term()_ function terminates the 0MQ context 'context'.
It does so in following steps:
* 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.
* 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
------------
The _zmq_term()_ function shall return zero if successful. Otherwise it shall
return `-1` and set 'errno' to one of the values defined below.
ERRORS
------
*EFAULT*::
The provided 'context' was not valid (NULL).
SEE ALSO
--------
linkzmq:zmq[7]
linkzmq:zmq_init[3]
linkzmq:zmq_close[3]
linkzmq:zmq_setsockopt[3]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.