~ubuntu-branches/ubuntu/wily/zeromq3/wily-proposed

« back to all changes in this revision

Viewing changes to doc/zmq_ctx_term.txt

  • Committer: Package Import Robot
  • Author(s): Alessandro Ghedini
  • Date: 2014-03-16 14:02:28 UTC
  • mfrom: (1.1.6) (6.1.1 experimental)
  • Revision ID: package-import@ubuntu.com-20140316140228-ig1sgh7czk59m9ux
Tags: 4.0.4+dfsg-1
* QA upload; orphan the package
  - Upload to unstable
* New upstream release
* Update repack.stub script
* Drop 02_fix-exported-symbols.patch and 03_fix-s390-rdtsc.patch
  (merged upstream)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
zmq_ctx_term(3)
 
2
===============
 
3
 
 
4
 
 
5
NAME
 
6
----
 
7
zmq_ctx_term - destroy a 0MQ context
 
8
 
 
9
 
 
10
SYNOPSIS
 
11
--------
 
12
*int zmq_ctx_term (void '*context');*
 
13
 
 
14
 
 
15
DESCRIPTION
 
16
-----------
 
17
The _zmq_ctx_term()_ function shall destroy the 0MQ context 'context'.
 
18
 
 
19
Context termination is performed in the following steps:
 
20
 
 
21
1. Any blocking operations currently in progress on sockets open within
 
22
   'context' shall return immediately with an error code of ETERM.  With the
 
23
   exception of _zmq_close()_, any further operations on sockets open within
 
24
   'context' shall fail with an error code of ETERM.
 
25
 
 
26
2. After interrupting all blocking calls, _zmq_ctx_term()_ shall _block_ until the
 
27
   following conditions are satisfied:
 
28
 
 
29
   * All sockets open within 'context' have been closed with _zmq_close()_.
 
30
 
 
31
   * For each socket within 'context', all messages sent by the application
 
32
     with _zmq_send()_ have either been physically transferred to a network
 
33
     peer, or the socket's linger period set with the _ZMQ_LINGER_ socket
 
34
     option has expired.
 
35
 
 
36
For further details regarding socket linger behavior refer to the _ZMQ_LINGER_
 
37
option in linkzmq:zmq_setsockopt[3].
 
38
 
 
39
This function replaces the deprecated function linkzmq:zmq_term[3].
 
40
 
 
41
 
 
42
RETURN VALUE
 
43
------------
 
44
The _zmq_ctx_term()_ function shall return zero if successful. Otherwise
 
45
it shall return `-1` and set 'errno' to one of the values defined below.
 
46
 
 
47
 
 
48
ERRORS
 
49
------
 
50
*EFAULT*::
 
51
The provided 'context' was invalid.
 
52
*EINTR*::
 
53
Termination was interrupted by a signal. It can be restarted if needed.
 
54
 
 
55
 
 
56
SEE ALSO
 
57
--------
 
58
linkzmq:zmq[7]
 
59
linkzmq:zmq_init[3]
 
60
linkzmq:zmq_close[3]
 
61
linkzmq:zmq_setsockopt[3]
 
62
 
 
63
 
 
64
AUTHORS
 
65
-------
 
66
This page was written by the 0MQ community. To make a change please
 
67
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.