zmq_ctx_term(3)

zmq_ctx_term(3)

ØMQ Manual - ØMQ/4.1.5

Name

zmq_ctx_term - destroy a ØMQ context

Synopsis

int zmq_ctx_term (void *context);

Description

The zmq_ctx_term() function shall destroy the ØMQ context context.

Context termination is performed in the following steps:

  • 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.
  • After interrupting all blocking calls, zmq_ctx_term() shall block until the following conditions are satisfied: <itemizedlist> <listitem> 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 zmq_setsockopt(3).

This function replaces the deprecated function zmq_term(3).

Warning

As ZMQ_LINGER defaults to "infinite", by default this function will block indefinitely if there are any pending connects or sends. We strongly recommend to (a) set ZMQ_LINGER to zero on all sockets and (b) close all sockets, before calling this function.

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

zmq(7) zmq_init(3) zmq_close(3) zmq_setsockopt(3)

Authors

This page was written by the ØMQ community. To make a change please read the ØMQ Contribution Policy at http://www.zeromq.org/docs:contributing.