zio.message Namespace Reference

Classes
class	CoordHeader
class	Message
class	MessageLevel
class	PrefixHeader

Functions
def	encode_message (parts)
def	decode_message (encoded)
def	encode_header_prefix (mform="FLOW", level=0, label="")
def	decode_header_prefix (henc)
def	encode_header_coord (origin, granule, seqno)
def	decode_header_coord (henc)

Detailed Description

Python interface to ZIO messages

Function Documentation

decode_header_coord()

def zio.message.decode_header_coord

(

henc

)

Parse the bytes of one encoded message part into a ZIO message
header coord.  This is ususally the second part of a multipart
message or as returend by decode().  Returns tuple (origin,
granule, seqno) or None if parse error.

Definition at line 366 of file message.py.

decode_header_prefix()

def zio.message.decode_header_prefix

(

henc

)

Parse the bytes of one encoded message part into a ZIO message
header prefix.  This is usually the first part of a multipart
message or as returned by decode().  Returns tuple (level, format,
label) or None if parse error.

Definition at line 342 of file message.py.

decode_message()

def zio.message.decode_message

(

encoded

)

Unpack an encoded single-part ZIO message such as returned by
socket.recv() on a SERVER socket.  It's the moral opposite of
zio::Message::encode().  What is returned is sequence of message
parts.

Definition at line 309 of file message.py.

encode_header_coord()

def zio.message.encode_header_coord	(		origin,
			granule,
			seqno
	)

Return a binary encoded header coord suitable for use as a message
part.  Arguments are taken to be 64 bit unsigned ints.

Definition at line 358 of file message.py.

encode_header_prefix()

def zio.message.encode_header_prefix	(		mform = "FLOW",
			level = 0,
			label = ""
	)

Return a binary encoded header prefix suitable for use as a
message part.

Definition at line 332 of file message.py.

encode_message()

def zio.message.encode_message

(

parts

)

Return a binary encoded concatenation of parts in the input
sequence.  Result is suitable for use as a single-part message.
For ZIO messages the first two parts should be encoded header
prefix and coord, respectively.  Subseqent parts can be payload of
arbitrary encoding.

Definition at line 295 of file message.py.