89 lines
2.9 KiB
Python
89 lines
2.9 KiB
Python
|
# coding: utf-8
|
||
|
|
"""0MQ Frame pure Python methods."""
|
||
|
|
|
||
|
|
# Copyright (C) PyZMQ Developers
|
||
|
|
# Distributed under the terms of the Modified BSD License.
|
||
|
|
|
||
|
|
from .attrsettr import AttributeSetter
|
||
|
|
from zmq.backend import Frame as FrameBase
|
||
|
|
import zmq
|
||
|
|
|
||
|
|
def _draft(v, feature):
|
||
|
|
zmq.error._check_version(v, feature)
|
||
|
|
if not zmq.DRAFT_API:
|
||
|
|
raise RuntimeError("libzmq and pyzmq must be built with draft support for %s" % feature)
|
||
|
|
|
||
|
|
class Frame(FrameBase, AttributeSetter):
|
||
|
|
"""Frame(data=None, track=False, copy=None, copy_threshold=zmq.COPY_THRESHOLD)
|
||
|
|
|
||
|
|
A zmq message Frame class for non-copy send/recvs.
|
||
|
|
|
||
|
|
This class is only needed if you want to do non-copying send and recvs.
|
||
|
|
When you pass a string to this class, like ``Frame(s)``, the
|
||
|
|
ref-count of `s` is increased by two: once because the Frame saves `s` as
|
||
|
|
an instance attribute and another because a ZMQ message is created that
|
||
|
|
points to the buffer of `s`. This second ref-count increase makes sure
|
||
|
|
that `s` lives until all messages that use it have been sent. Once 0MQ
|
||
|
|
sends all the messages and it doesn't need the buffer of s, 0MQ will call
|
||
|
|
``Py_DECREF(s)``.
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
|
||
|
|
data : object, optional
|
||
|
|
any object that provides the buffer interface will be used to
|
||
|
|
construct the 0MQ message data.
|
||
|
|
track : bool [default: False]
|
||
|
|
whether a MessageTracker_ should be created to track this object.
|
||
|
|
Tracking a message has a cost at creation, because it creates a threadsafe
|
||
|
|
Event object.
|
||
|
|
copy : bool [default: use copy_threshold]
|
||
|
|
Whether to create a copy of the data to pass to libzmq
|
||
|
|
or share the memory with libzmq.
|
||
|
|
If unspecified, copy_threshold is used.
|
||
|
|
copy_threshold: int [default: zmq.COPY_THRESHOLD]
|
||
|
|
If copy is unspecified, messages smaller than this many bytes
|
||
|
|
will be copied and messages larger than this will be shared with libzmq.
|
||
|
|
"""
|
||
|
|
|
||
|
|
def __getitem__(self, key):
|
||
|
|
# map Frame['User-Id'] to Frame.get('User-Id')
|
||
|
|
return self.get(key)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def group(self):
|
||
|
|
"""The RADIO-DISH group of the message.
|
||
|
|
|
||
|
|
Requires libzmq >= 4.2 and pyzmq built with draft APIs enabled.
|
||
|
|
|
||
|
|
.. versionadded:: 17
|
||
|
|
"""
|
||
|
|
_draft((4,2), "RADIO-DISH")
|
||
|
|
return self.get('group')
|
||
|
|
|
||
|
|
@group.setter
|
||
|
|
def group(self, group):
|
||
|
|
_draft((4,2), "RADIO-DISH")
|
||
|
|
self.set('group', group)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def routing_id(self):
|
||
|
|
"""The CLIENT-SERVER routing id of the message.
|
||
|
|
|
||
|
|
Requires libzmq >= 4.2 and pyzmq built with draft APIs enabled.
|
||
|
|
|
||
|
|
.. versionadded:: 17
|
||
|
|
"""
|
||
|
|
_draft((4,2), "CLIENT-SERVER")
|
||
|
|
return self.get('routing_id')
|
||
|
|
|
||
|
|
@routing_id.setter
|
||
|
|
def routing_id(self, routing_id):
|
||
|
|
_draft((4,2), "CLIENT-SERVER")
|
||
|
|
self.set('routing_id', routing_id)
|
||
|
|
|
||
|
|
|
||
|
|
# keep deprecated alias
|
||
|
|
Message = Frame
|
||
|
|
__all__ = ['Frame', 'Message']
|