1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
"""0MQ Context class."""
# coding: utf-8
# Copyright (c) PyZMQ Developers.
# Distributed under the terms of the Lesser GNU Public License (LGPL).
from libc.stdlib cimport free, malloc, realloc
from libzmq cimport *
cdef extern from "getpid_compat.h":
int getpid()
from zmq.error import ZMQError, InterruptedSystemCall
from zmq.backend.cython.checkrc cimport _check_rc
_instance = None
cdef class Context:
"""Context(io_threads=1)
Manage the lifecycle of a 0MQ context.
Parameters
----------
io_threads : int
The number of IO threads.
"""
# no-op for the signature
def __init__(self, io_threads=1, shadow=0):
pass
def __cinit__(self, int io_threads=1, size_t shadow=0, **kwargs):
self.handle = NULL
self._sockets = NULL
if shadow:
self.handle = <void *>shadow
self._shadow = True
else:
self._shadow = False
if ZMQ_VERSION_MAJOR >= 3:
self.handle = zmq_ctx_new()
else:
self.handle = zmq_init(io_threads)
if self.handle == NULL:
raise ZMQError()
cdef int rc = 0
if ZMQ_VERSION_MAJOR >= 3 and not self._shadow:
rc = zmq_ctx_set(self.handle, ZMQ_IO_THREADS, io_threads)
_check_rc(rc)
self.closed = False
self._n_sockets = 0
self._max_sockets = 32
self._sockets = <void **>malloc(self._max_sockets*sizeof(void *))
if self._sockets == NULL:
raise MemoryError("Could not allocate _sockets array")
self._pid = getpid()
def __dealloc__(self):
"""don't touch members in dealloc, just cleanup allocations"""
cdef int rc
if self._sockets != NULL:
free(self._sockets)
self._sockets = NULL
self._n_sockets = 0
# we can't call object methods in dealloc as it
# might already be partially deleted
if not self._shadow:
self._term()
cdef inline void _add_socket(self, void* handle):
"""Add a socket handle to be closed when Context terminates.
This is to be called in the Socket constructor.
"""
if self._n_sockets >= self._max_sockets:
self._max_sockets *= 2
self._sockets = <void **>realloc(self._sockets, self._max_sockets*sizeof(void *))
if self._sockets == NULL:
raise MemoryError("Could not reallocate _sockets array")
self._sockets[self._n_sockets] = handle
self._n_sockets += 1
cdef inline void _remove_socket(self, void* handle):
"""Remove a socket from the collected handles.
This should be called by Socket.close, to prevent trying to
close a socket a second time.
"""
cdef bint found = False
for idx in range(self._n_sockets):
if self._sockets[idx] == handle:
found=True
break
if found:
self._n_sockets -= 1
if self._n_sockets:
# move last handle to closed socket's index
self._sockets[idx] = self._sockets[self._n_sockets]
@property
def underlying(self):
"""The address of the underlying libzmq context"""
return <size_t> self.handle
# backward-compat, though nobody is using it
_handle = underlying
cdef inline int _term(self):
cdef int rc=0
if self.handle != NULL and not self.closed and getpid() == self._pid:
with nogil:
rc = zmq_ctx_destroy(self.handle)
self.handle = NULL
return rc
def term(self):
"""ctx.term()
Close or terminate the context.
This can be called to close the context by hand. If this is not called,
the context will automatically be closed when it is garbage collected.
"""
cdef int rc=0
rc = self._term()
try:
_check_rc(rc)
except InterruptedSystemCall:
# ignore interrupted term
# see PEP 475 notes about close & EINTR for why
pass
self.closed = True
def set(self, int option, optval):
"""ctx.set(option, optval)
Set a context option.
See the 0MQ API documentation for zmq_ctx_set
for details on specific options.
.. versionadded:: libzmq-3.2
.. versionadded:: 13.0
Parameters
----------
option : int
The option to set. Available values will depend on your
version of libzmq. Examples include::
zmq.IO_THREADS, zmq.MAX_SOCKETS
optval : int
The value of the option to set.
"""
cdef int optval_int_c
cdef int rc
cdef char* optval_c
if self.closed:
raise RuntimeError("Context has been destroyed")
if not isinstance(optval, int):
raise TypeError('expected int, got: %r' % optval)
optval_int_c = optval
rc = zmq_ctx_set(self.handle, option, optval_int_c)
_check_rc(rc)
def get(self, int option):
"""ctx.get(option)
Get the value of a context option.
See the 0MQ API documentation for zmq_ctx_get
for details on specific options.
.. versionadded:: libzmq-3.2
.. versionadded:: 13.0
Parameters
----------
option : int
The option to get. Available values will depend on your
version of libzmq. Examples include::
zmq.IO_THREADS, zmq.MAX_SOCKETS
Returns
-------
optval : int
The value of the option as an integer.
"""
cdef int optval_int_c
cdef size_t sz
cdef int rc
if self.closed:
raise RuntimeError("Context has been destroyed")
rc = zmq_ctx_get(self.handle, option)
_check_rc(rc)
return rc
def destroy(self, linger=None):
"""ctx.destroy(linger=None)
Close all sockets associated with this context, and then terminate
the context. If linger is specified,
the LINGER sockopt of the sockets will be set prior to closing.
.. warning::
destroy involves calling ``zmq_close()``, which is **NOT** threadsafe.
If there are active sockets in other threads, this must not be called.
"""
cdef int linger_c
cdef bint setlinger=False
if linger is not None:
linger_c = linger
setlinger=True
if self.handle != NULL and not self.closed and self._n_sockets:
while self._n_sockets:
if setlinger:
zmq_setsockopt(self._sockets[0], ZMQ_LINGER, &linger_c, sizeof(int))
rc = zmq_close(self._sockets[0])
if rc < 0 and zmq_errno() != ZMQ_ENOTSOCK:
raise ZMQError()
self._n_sockets -= 1
self._sockets[0] = self._sockets[self._n_sockets]
self.term()
__all__ = ['Context']
|
