From 597cc5edd624525563e6549dc0057eca2a51c81d Mon Sep 17 00:00:00 2001 From: Micah Anderson Date: Tue, 11 Nov 2014 13:30:46 -0500 Subject: upgrade to new version --- doc/zmq_ctx_destroy.txt | 67 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 doc/zmq_ctx_destroy.txt (limited to 'doc/zmq_ctx_destroy.txt') diff --git a/doc/zmq_ctx_destroy.txt b/doc/zmq_ctx_destroy.txt new file mode 100644 index 0000000..9b24119 --- /dev/null +++ b/doc/zmq_ctx_destroy.txt @@ -0,0 +1,67 @@ +zmq_ctx_destroy(3) +================== + + +NAME +---- +zmq_ctx_destroy - terminate a 0MQ context + + +SYNOPSIS +-------- +*int zmq_ctx_destroy (void '*context');* + + +DESCRIPTION +----------- +The _zmq_ctx_destroy()_ 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. + +2. After interrupting all blocking calls, _zmq_ctx_destroy()_ shall _block_ until the + following conditions are satisfied: + + * 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. + +For further details regarding socket linger behavior refer to the _ZMQ_LINGER_ +option in linkzmq:zmq_setsockopt[3]. + +This function is deprecated by linkzmq:zmq_ctx_term[3]. + + +RETURN VALUE +------------ +The _zmq_ctx_destroy()_ 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 +------- +This page was written by the 0MQ community. To make a change please +read the 0MQ Contribution Policy at . -- cgit v1.2.3