summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMartin Lucina <mato@kotelna.sk>2010-06-01 22:22:29 +0200
committerMartin Lucina <mato@kotelna.sk>2010-06-01 22:22:29 +0200
commit8ba1d3c8ed32b39bb1133330d496587d96020e7e (patch)
tree392442360ba9316b00c972426e3a2129fcd78832 /doc
parent74a03dfd7dbb762be5d50eca4df214f8825ad44a (diff)
Documentation: zmq_term() and ETERM for 2.0.7
Diffstat (limited to 'doc')
-rw-r--r--doc/zmq_bind.txt2
-rw-r--r--doc/zmq_connect.txt2
-rw-r--r--doc/zmq_getsockopt.txt1
-rw-r--r--doc/zmq_poll.txt6
-rw-r--r--doc/zmq_setsockopt.txt1
-rw-r--r--doc/zmq_term.txt20
6 files changed, 21 insertions, 11 deletions
diff --git a/doc/zmq_bind.txt b/doc/zmq_bind.txt
index c76d05a..a74e81d 100644
--- a/doc/zmq_bind.txt
+++ b/doc/zmq_bind.txt
@@ -55,7 +55,7 @@ The requested 'address' was not local.
*ENODEV*::
The requested 'address' specifies a nonexistent interface.
*ETERM*::
-The associated context was terminted.
+The 0MQ 'context' associated with the specified 'socket' was terminated.
EXAMPLE
diff --git a/doc/zmq_connect.txt b/doc/zmq_connect.txt
index 2bc8e4f..0061c37 100644
--- a/doc/zmq_connect.txt
+++ b/doc/zmq_connect.txt
@@ -53,7 +53,7 @@ The requested 'transport' protocol is not supported.
*ENOCOMPATPROTO*::
The requested 'transport' protocol is not compatible with the socket type.
*ETERM*::
-The associated context was terminted.
+The 0MQ 'context' associated with the specified 'socket' was terminated.
EXAMPLE
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt
index 3225a18..318d12e 100644
--- a/doc/zmq_getsockopt.txt
+++ b/doc/zmq_getsockopt.txt
@@ -199,7 +199,6 @@ The requested option _option_name_ is unknown, or the requested _option_len_ or
_option_value_ is invalid, or the size of the buffer pointed to by
_option_value_, as specified by _option_len_, is insufficient for storing the
option value.
-
*ETERM*::
The 0MQ 'context' associated with the specified 'socket' was terminated.
diff --git a/doc/zmq_poll.txt b/doc/zmq_poll.txt
index bb105b4..9106b5b 100644
--- a/doc/zmq_poll.txt
+++ b/doc/zmq_poll.txt
@@ -93,11 +93,9 @@ ERRORS
*EFAULT*::
At least one of the members of the 'items' array refers to a 'socket' belonging
to a different application thread.
-*ENOTSUP*::
-At least one of the members of the 'items' array refers to a 'socket' whose
-associated 0MQ 'context' was initialised without the 'ZMQ_POLL' flag.
*ETERM*::
-The associated context was terminted.
+At least one of the members of the 'items' array refers to a 'socket' whose
+associated 0MQ 'context' was terminated.
EXAMPLE
diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt
index d9ba612..7721eff 100644
--- a/doc/zmq_setsockopt.txt
+++ b/doc/zmq_setsockopt.txt
@@ -213,7 +213,6 @@ ERRORS
*EINVAL*::
The requested option _option_name_ is unknown, or the requested _option_len_ or
_option_value_ is invalid.
-
*ETERM*::
The 0MQ 'context' associated with the specified 'socket' was terminated.
diff --git a/doc/zmq_term.txt b/doc/zmq_term.txt
index 2e15c24..820fa30 100644
--- a/doc/zmq_term.txt
+++ b/doc/zmq_term.txt
@@ -16,9 +16,23 @@ DESCRIPTION
-----------
The _zmq_term()_ function terminates the 0MQ context 'context'.
-If there are still sockets open within 'context' at the time _zmq_term()_ is
-called the call will succeed but the actual shutdown of 'context' will be
-delayed until the last socket within it is closed.
+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.
+
+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.
+
+* 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()_.
RETURN VALUE