zmq_ctx_shutdown.txt 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. zmq_ctx_shutdown(3)
  2. ==================
  3. NAME
  4. ----
  5. zmq_ctx_shutdown - shutdown a 0MQ context
  6. SYNOPSIS
  7. --------
  8. *int zmq_ctx_shutdown (void '*context');*
  9. DESCRIPTION
  10. -----------
  11. The _zmq_ctx_shutdown()_ function shall shutdown the 0MQ context 'context'.
  12. Context shutdown will cause any blocking operations currently in progress on
  13. sockets open within 'context' to return immediately with an error code of ETERM.
  14. With the exception of _zmq_close()_, any further operations on sockets open within
  15. 'context' shall fail with an error code of ETERM. No further sockets can be created
  16. using _zmq_socket()_ on a context for which _zmq_ctx_shutdown()_ has been called,
  17. it will return and set errno to ETERM.
  18. This function is optional, client code is still required to call the linkzmq:zmq_ctx_term[3]
  19. function to free all resources allocated by zeromq.
  20. RETURN VALUE
  21. ------------
  22. The _zmq_ctx_shutdown()_ function shall return zero if successful. Otherwise
  23. it shall return `-1` and set 'errno' to one of the values defined below.
  24. ERRORS
  25. ------
  26. *EFAULT*::
  27. The provided 'context' was invalid.
  28. SEE ALSO
  29. --------
  30. linkzmq:zmq[7]
  31. linkzmq:zmq_init[3]
  32. linkzmq:zmq_ctx_term[3]
  33. linkzmq:zmq_close[3]
  34. linkzmq:zmq_setsockopt[3]
  35. AUTHORS
  36. -------
  37. This page was written by the 0MQ community. To make a change please
  38. read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.