def set_keepalive(socket: Socket, config):
# This assumes the same TCP_KEEPALIVE configuration for all sockets which
# is not ideal but matches what we do in code
socket.setsockopt(zmq.TCP_KEEPALIVE, 1)
socket.setsockopt(zmq.TCP_KEEPALIVE_INTVL, config.KEEPALIVE_INTVL)
socket.setsockopt(zmq.TCP_KEEPALIVE_IDLE, config.KEEPALIVE_IDLE)
socket.setsockopt(zmq.TCP_KEEPALIVE_CNT, config.KEEPALIVE_CNT)
def set_keepalive(socket: Socket, config):
# This assumes the same TCP_KEEPALIVE configuration for all sockets which
# is not ideal but matches what we do in code
socket.setsockopt(zmq.TCP_KEEPALIVE, 1)
socket.setsockopt(zmq.TCP_KEEPALIVE_INTVL, config.KEEPALIVE_INTVL)
socket.setsockopt(zmq.TCP_KEEPALIVE_IDLE, config.KEEPALIVE_IDLE)
socket.setsockopt(zmq.TCP_KEEPALIVE_CNT, config.KEEPALIVE_CNT)
def __init__(self, factory, endpoint=None, identity=None):
"""
Constructor.
One endpoint is passed to the constructor, more could be added
via call to C{addEndpoints}.
@param factory: ZeroMQ Twisted factory
@type factory: L{ZmqFactory}
@param endpoint: ZeroMQ address for connect/bind
@type endpoint: C{list} of L{ZmqEndpoint}
@param identity: socket identity (ZeroMQ)
@type identity: C{str}
"""
self.factory = factory
self.endpoints = []
self.identity = identity
self.socket = Socket(factory.context, self.socketType)
self.queue = deque()
self.recv_parts = []
self.read_scheduled = None
self.fd = self.socket.getsockopt(constants.FD)
self.socket.setsockopt(constants.LINGER, factory.lingerPeriod)
if not ZMQ3:
self.socket.setsockopt(
constants.MCAST_LOOP, int(self.allowLoopbackMulticast))
self.socket.setsockopt(constants.RATE, self.multicastRate)
if not ZMQ3:
self.socket.setsockopt(constants.HWM, self.highWaterMark)
else:
self.socket.setsockopt(constants.SNDHWM, self.highWaterMark)
self.socket.setsockopt(constants.RCVHWM, self.highWaterMark)
if ZMQ3 and self.tcpKeepalive:
self.socket.setsockopt(
constants.TCP_KEEPALIVE, self.tcpKeepalive)
self.socket.setsockopt(
constants.TCP_KEEPALIVE_CNT, self.tcpKeepaliveCount)
self.socket.setsockopt(
constants.TCP_KEEPALIVE_IDLE, self.tcpKeepaliveIdle)
self.socket.setsockopt(
constants.TCP_KEEPALIVE_INTVL, self.tcpKeepaliveInterval)
if self.identity is not None:
self.socket.setsockopt(constants.IDENTITY, self.identity)
if endpoint:
self.addEndpoints([endpoint])
self.factory.connections.add(self)
self.factory.reactor.addReader(self)
self.doRead()
def set_zmq_internal_queue_length(socket: Socket, config):
# set both ZMQ_RCVHWM and ZMQ_SNDHWM
socket.set_hwm(config.ZMQ_INTERNAL_QUEUE_SIZE)
def set_zmq_internal_queue_size(socket: Socket, queue_size: int):
# set both ZMQ_RCVHWM and ZMQ_SNDHWM
socket.set_hwm(queue_size)
class ZmqConnection(object):
"""
Connection through ZeroMQ, wraps up ZeroMQ socket.
@cvar socketType: socket type, from ZeroMQ
@cvar allowLoopbackMulticast: is loopback multicast allowed?
@type allowLoopbackMulticast: C{boolean}
@cvar multicastRate: maximum allowed multicast rate, kbps
@type multicastRate: C{int}
@cvar highWaterMark: hard limit on the maximum number of outstanding
messages 0MQ shall queue in memory for any single peer
@type highWaterMark: C{int}
@ivar factory: ZeroMQ Twisted factory reference
@type factory: L{ZmqFactory}
@ivar socket: ZeroMQ Socket
@type socket: L{Socket}
@ivar endpoints: ZeroMQ addresses for connect/bind
@type endpoints: C{list} of L{ZmqEndpoint}
@ivar fd: file descriptor of zmq mailbox
@type fd: C{int}
@ivar queue: output message queue
@type queue: C{deque}
"""
implements(IReadDescriptor, IFileDescriptor)
socketType = None
allowLoopbackMulticast = False
multicastRate = 100
highWaterMark = 0
# Only supported by zeromq3 and pyzmq>=2.2.0.1
tcpKeepalive = 0
tcpKeepaliveCount = 0
tcpKeepaliveIdle = 0
tcpKeepaliveInterval = 0
def __init__(self, factory, endpoint=None, identity=None):
"""
Constructor.
One endpoint is passed to the constructor, more could be added
via call to C{addEndpoints}.
@param factory: ZeroMQ Twisted factory
@type factory: L{ZmqFactory}
@param endpoint: ZeroMQ address for connect/bind
@type endpoint: C{list} of L{ZmqEndpoint}
@param identity: socket identity (ZeroMQ)
@type identity: C{str}
"""
self.factory = factory
self.endpoints = []
self.identity = identity
self.socket = Socket(factory.context, self.socketType)
self.queue = deque()
self.recv_parts = []
self.read_scheduled = None
self.fd = self.socket.getsockopt(constants.FD)
self.socket.setsockopt(constants.LINGER, factory.lingerPeriod)
if not ZMQ3:
self.socket.setsockopt(
constants.MCAST_LOOP, int(self.allowLoopbackMulticast))
self.socket.setsockopt(constants.RATE, self.multicastRate)
if not ZMQ3:
self.socket.setsockopt(constants.HWM, self.highWaterMark)
else:
self.socket.setsockopt(constants.SNDHWM, self.highWaterMark)
self.socket.setsockopt(constants.RCVHWM, self.highWaterMark)
if ZMQ3 and self.tcpKeepalive:
self.socket.setsockopt(
constants.TCP_KEEPALIVE, self.tcpKeepalive)
self.socket.setsockopt(
constants.TCP_KEEPALIVE_CNT, self.tcpKeepaliveCount)
self.socket.setsockopt(
constants.TCP_KEEPALIVE_IDLE, self.tcpKeepaliveIdle)
self.socket.setsockopt(
constants.TCP_KEEPALIVE_INTVL, self.tcpKeepaliveInterval)
if self.identity is not None:
self.socket.setsockopt(constants.IDENTITY, self.identity)
if endpoint:
self.addEndpoints([endpoint])
self.factory.connections.add(self)
self.factory.reactor.addReader(self)
self.doRead()
def addEndpoints(self, endpoints):
"""
Add more connection endpoints. Connection may have
many endpoints, mixing protocols and types.
@param endpoints: list of endpoints to add
@type endpoints: C{list}
"""
self.endpoints.extend(endpoints)
self._connectOrBind(endpoints)
def shutdown(self):
"""
Shutdown connection and socket.
"""
self.factory.reactor.removeReader(self)
self.factory.connections.discard(self)
self.socket.close()
self.socket = None
self.factory = None
if self.read_scheduled is not None:
self.read_scheduled.cancel()
self.read_scheduled = None
def __repr__(self):
return "%s(%r, %r)" % (
self.__class__.__name__, self.factory, self.endpoints)
def fileno(self):
"""
Part of L{IFileDescriptor}.
@return: The platform-specified representation of a file descriptor
number.
"""
return self.fd
def connectionLost(self, reason):
"""
Called when the connection was lost.
Part of L{IFileDescriptor}.
This is called when the connection on a selectable object has been
lost. It will be called whether the connection was closed explicitly,
an exception occurred in an event handler, or the other end of the
connection closed it first.
@param reason: A failure instance indicating the reason why the
connection was lost. L{error.ConnectionLost} and
L{error.ConnectionDone} are of special note, but the
failure may be of other classes as well.
"""
if self.factory:
self.factory.reactor.removeReader(self)
def _readMultipart(self):
"""
Read multipart in non-blocking manner, returns with ready message
or raising exception (in case of no more messages available).
"""
while True:
self.recv_parts.append(self.socket.recv(constants.NOBLOCK))
if not self.socket.getsockopt(constants.RCVMORE):
result, self.recv_parts = self.recv_parts, []
return result
def doRead(self):
"""
Some data is available for reading on your descriptor.
ZeroMQ is signalling that we should process some events,
we're starting to to receive incoming messages.
Part of L{IReadDescriptor}.
"""
if self.read_scheduled is not None:
if not self.read_scheduled.called:
self.read_scheduled.cancel()
self.read_scheduled = None
while True:
if self.factory is None: # disconnected
return
events = self.socket.getsockopt(constants.EVENTS)
if (events & constants.POLLIN) != constants.POLLIN:
return
try:
message = self._readMultipart()
except error.ZMQError as e:
if e.errno == constants.EAGAIN:
continue
raise e
log.callWithLogger(self, self.messageReceived, message)
def logPrefix(self):
"""
Part of L{ILoggingContext}.
@return: Prefix used during log formatting to indicate context.
@rtype: C{str}
"""
return 'ZMQ'
def send(self, message):
"""
Send message via ZeroMQ.
Sending is performed directly to ZeroMQ without queueing. If HWM is
reached on ZeroMQ side, sending operation is aborted with exception
from ZeroMQ (EAGAIN).
@param message: message data
@type message: message could be either list of parts or single
part (str)
"""
if not hasattr(message, '__iter__'):
self.socket.send(message, constants.NOBLOCK)
else:
for m in message[:-1]:
self.socket.send(m, constants.NOBLOCK | constants.SNDMORE)
self.socket.send(message[-1], constants.NOBLOCK)
if self.read_scheduled is None:
self.read_scheduled = reactor.callLater(0, self.doRead)
def messageReceived(self, message):
"""
Called on incoming message from ZeroMQ.
@param message: message data
"""
raise NotImplementedError(self)
def _connectOrBind(self, endpoints):
"""
Connect and/or bind socket to endpoints.
"""
for endpoint in endpoints:
if endpoint.type == ZmqEndpointType.connect:
self.socket.connect(endpoint.address)
elif endpoint.type == ZmqEndpointType.bind:
self.socket.bind(endpoint.address)
else:
assert False, "Unknown endpoint type %r" % endpoint
def set_zmq_internal_queue_size(socket: Socket, queue_size: int):
# set both ZMQ_RCVHWM and ZMQ_SNDHWM
socket.set_hwm(queue_size)
