zmq_term.txt 1.63 KB
Newer Older
1 2 3 4 5 6
zmq_term(3)
===========


NAME
----
Martin Lucina's avatar
Martin Lucina committed
7
zmq_term - terminate 0MQ context
8 9 10 11


SYNOPSIS
--------
Martin Lucina's avatar
Martin Lucina committed
12
*int zmq_term (void '*context');*
13 14 15 16


DESCRIPTION
-----------
17
The _zmq_term()_ function shall terminate the 0MQ context 'context'.
Martin Lucina's avatar
Martin Lucina committed
18

19
Context termination is performed in the following steps:
20

21 22 23 24
1. 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 within
   'context' shall fail with an error code of ETERM.
25

26 27 28 29
2. After interrupting all blocking calls, _zmq_term()_ shall _block_ until the
   following conditions are satisfied:
+
   * All sockets open within 'context' have been closed with _zmq_close()_.
30

31 32 33 34 35 36 37
   * For each socket within 'context', all messages sent by the application
     with _zmq_send()_ have either been physically transferred to a network
     peer, or the socket's linger period set with the _ZMQ_LINGER_ socket
     option has expired.

For further details regarding socket linger behaviour refer to the _ZMQ_LINGER_
option in linkzmq:zmq_setsockopt[3].
38 39 40 41


RETURN VALUE
------------
Martin Lucina's avatar
Martin Lucina committed
42
The _zmq_term()_ function shall return zero if successful. Otherwise it shall
Martin Lucina's avatar
Martin Lucina committed
43
return `-1` and set 'errno' to one of the values defined below.
44 45 46 47


ERRORS
------
48
*EFAULT*::
49
The provided 'context' was invalid.
50 51
*EINTR*::
Termination was interrupted by a signal. It can be restarted if needed.
52 53 54 55


SEE ALSO
--------
Martin Lucina's avatar
Martin Lucina committed
56
linkzmq:zmq[7]
57
linkzmq:zmq_init[3]
58 59
linkzmq:zmq_close[3]
linkzmq:zmq_setsockopt[3]
60

61 62 63 64 65

AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.