3party/libzmq
0
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-30 01:06:55 +08:00
Code Issues Projects Releases Wiki Activity
libzmq/doc/zmq_ctx_term.txt

69 lines
1.8 KiB
Plaintext
Raw Normal View History

deprecate zmq_ctx_destroy in favor of zmq_ctx_term in order to avoid logical collisions with pre-existing notions of context destruction in bindings (czmq, pyzmq).
2013-01-17 14:36:38 -08:00
zmq_ctx_term(3)
Shortening the =-chars to make asciidoc work
2013-01-19 18:02:24 +01:00
===============
deprecate zmq_ctx_destroy in favor of zmq_ctx_term in order to avoid logical collisions with pre-existing notions of context destruction in bindings (czmq, pyzmq).
2013-01-17 14:36:38 -08:00
NAME
----
update zmq_ctx_term description for consistency zmq_term and zmq_ctx_destroy are just aliases for zmq_ctx_term. that being the case use 'terminate' in the description for all three so there isn't any confusion about behavior. also update the deprecates list in zmq_ctx_term to include zmq_ctx_destroy.
2015-03-15 06:29:21 -05:00
zmq_ctx_term - terminate a 0MQ context
deprecate zmq_ctx_destroy in favor of zmq_ctx_term in order to avoid logical collisions with pre-existing notions of context destruction in bindings (czmq, pyzmq).
2013-01-17 14:36:38 -08:00
SYNOPSIS
--------
*int zmq_ctx_term (void '*context');*
DESCRIPTION
-----------
The _zmq_ctx_term()_ function shall destroy the 0MQ context 'context'.
Context termination is performed in the following steps:
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.
Problem: zmq_ctx_term has insane behavior by default Solution: document this with a clear warning. It would be nicer perhaps to change the default LINGER to e.g. a few seconds. However this could break existing applications.
2014-11-06 10:55:26 +01:00
2. After interrupting all blocking calls, _zmq_ctx_term()_ shall _block_ until
the following conditions are satisfied:
deprecate zmq_ctx_destroy in favor of zmq_ctx_term in order to avoid logical collisions with pre-existing notions of context destruction in bindings (czmq, pyzmq).
2013-01-17 14:36:38 -08:00
* All sockets open within 'context' have been closed with _zmq_close()_.
* 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.
Use consistant spelling in documentation behavior -> behaviour initialize -> initialse initialization -> initialisation
2014-11-07 22:24:07 -08:00
For further details regarding socket linger behaviour refer to the _ZMQ_LINGER_
deprecate zmq_ctx_destroy in favor of zmq_ctx_term in order to avoid logical collisions with pre-existing notions of context destruction in bindings (czmq, pyzmq).
2013-01-17 14:36:38 -08:00
option in linkzmq:zmq_setsockopt[3].
update zmq_ctx_term description for consistency zmq_term and zmq_ctx_destroy are just aliases for zmq_ctx_term. that being the case use 'terminate' in the description for all three so there isn't any confusion about behavior. also update the deprecates list in zmq_ctx_term to include zmq_ctx_destroy.
2015-03-15 06:29:21 -05:00
This function replaces the deprecated functions linkzmq:zmq_term[3] and
linkzmq:zmq_ctx_destroy[3].
deprecate zmq_ctx_destroy in favor of zmq_ctx_term in order to avoid logical collisions with pre-existing notions of context destruction in bindings (czmq, pyzmq).
2013-01-17 14:36:38 -08:00
RETURN VALUE
------------
The _zmq_ctx_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 invalid.
*EINTR*::
Termination was interrupted by a signal. It can be restarted if needed.
SEE ALSO
--------
linkzmq:zmq[7]
linkzmq:zmq_init[3]
linkzmq:zmq_close[3]
linkzmq:zmq_setsockopt[3]
AUTHORS
-------
Use of named authors on man pages is no longer a good idea since it puts off contributors and doesn't reflect the real process. I've taken out all named authors and referred to the contribution policy. Hopefully this will improve the contributions to the man pages.
2013-04-11 18:53:02 +02:00
This page was written by the 0MQ community. To make a change please
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.
Reference in New Issue Copy Permalink