zio.message.Message Class Reference

Public Member Functions
def	__init__ (self, level=None, form=None, label=None, routing_id=None, origin=None, granule=None, seqno=None, prefix=None, coord=None, payload=None, parts=None, encoded=None, frame=None)
def	form (self)
def	form (self, val)
def	level (self)
def	level (self, val)
def	label (self)
def	label (self, val)
def	label_object (self)
def	label_object (self, val)
def	origin (self)
def	origin (self, val)
def	granule (self)
def	granule (self, val)
def	seqno (self)
def	seqno (self, val)
def	payload (self)
def	payload (self, pl)
def	toframe (self)
def	fromframe (self, frame)
def	encode (self)
def	decode (self, encoded)
def	toparts (self)
def	fromparts (self, parts)
def	__str__ (self)

Public Attributes
	payload
	routing_id
	label
	form
	level
	origin
	granule
	seqno

Static Public Attributes
int	routing_id = 0
	prefix = None
	coord = None

Detailed Description

A zio.Message fixes some of the message schema.

It is equivalent to a C++ zio::Message.

Definition at line 110 of file message.py.

Constructor & Destructor Documentation

__init__()

def zio.message.Message.__init__	(		self,
			level = None,
			form = None,
			label = None,
			routing_id = None,
			origin = None,
			granule = None,
			seqno = None,
			prefix = None,
			coord = None,
			payload = None,
			parts = None,
			encoded = None,
			frame = None
	)

Construct a zio.Message.

Construction applies arguments in reverse order.  Thus one
may, eg, construct a message with a frame and then override
the payload and label.  The ingredients may be considered
deconstructed as:

    frame = encoding + routing_id

    encoding = packing of parts

    parts = [prefix, coord, ...payloads]

A frame should be used when the zio.Message will be used with
a SERVER socket.  Or else the routing_id must be explicitly
set.

Definition at line 128 of file message.py.

Member Function Documentation

__str__()

def zio.message.Message.__str__

(

self

)

Definition at line 290 of file message.py.

decode()

def zio.message.Message.decode	(		self,
			encoded
	)

Decode to self.

Definition at line 266 of file message.py.

encode()

def zio.message.Message.encode

(

self

)

Return encoded byte array of self.

It is suitable for use as the data arg to a zmq.Frame

Definition at line 257 of file message.py.

form() [1/2]

def zio.message.Message.form

(

self

)

Definition at line 179 of file message.py.

form() [2/2]

def zio.message.Message.form	(		self,
			val
	)

Definition at line 182 of file message.py.

fromframe()

def zio.message.Message.fromframe	(		self,
			frame
	)

Set self from a frame

Definition at line 250 of file message.py.

fromparts()

def zio.message.Message.fromparts	(		self,
			parts
	)

Set self from multipart message / array of encoded data.

Definition at line 280 of file message.py.

granule() [1/2]

def zio.message.Message.granule

(

self

)

Definition at line 219 of file message.py.

granule() [2/2]

def zio.message.Message.granule	(		self,
			val
	)

Definition at line 222 of file message.py.

label() [1/2]

def zio.message.Message.label

(

self

)

Definition at line 193 of file message.py.

label() [2/2]

def zio.message.Message.label	(		self,
			val
	)

Definition at line 196 of file message.py.

label_object() [1/2]

def zio.message.Message.label_object

(

self

)

Definition at line 200 of file message.py.

label_object() [2/2]

def zio.message.Message.label_object	(		self,
			val
	)

Definition at line 208 of file message.py.

level() [1/2]

def zio.message.Message.level

(

self

)

Definition at line 186 of file message.py.

level() [2/2]

def zio.message.Message.level	(		self,
			val
	)

Definition at line 189 of file message.py.

origin() [1/2]

def zio.message.Message.origin

(

self

)

Definition at line 212 of file message.py.

origin() [2/2]

def zio.message.Message.origin	(		self,
			val
	)

Definition at line 215 of file message.py.

payload() [1/2]

def zio.message.Message.payload

(

self

)

Definition at line 234 of file message.py.

payload() [2/2]

def zio.message.Message.payload	(		self,
			pl
	)

Definition at line 238 of file message.py.

seqno() [1/2]

def zio.message.Message.seqno

(

self

)

Definition at line 226 of file message.py.

seqno() [2/2]

def zio.message.Message.seqno	(		self,
			val
	)

Definition at line 229 of file message.py.

toframe()

def zio.message.Message.toframe

(

self

)

Return self as a frame.

Definition at line 241 of file message.py.

toparts()

def zio.message.Message.toparts

(

self

)

Return self as a multipart set of encoded data

Definition at line 274 of file message.py.

Member Data Documentation

coord

zio.message.Message.coord = None

static

Definition at line 121 of file message.py.

form

zio.message.Message.form

Definition at line 167 of file message.py.

granule

zio.message.Message.granule

Definition at line 173 of file message.py.

label

zio.message.Message.label

Definition at line 165 of file message.py.

level

zio.message.Message.level

Definition at line 169 of file message.py.

origin

zio.message.Message.origin

Definition at line 171 of file message.py.

payload

zio.message.Message.payload

Definition at line 157 of file message.py.

prefix

zio.message.Message.prefix = None

static

Definition at line 120 of file message.py.

routing_id [1/2]

int zio.message.Message.routing_id = 0

static

Definition at line 119 of file message.py.

routing_id [2/2]

zio.message.Message.routing_id

Definition at line 163 of file message.py.

seqno

zio.message.Message.seqno

Definition at line 175 of file message.py.

---

The documentation for this class was generated from the following file:

• python/zio/message.py