urpc.util Namespace Reference

Classes
class	AllocTable
	The allocation table data structure. More...

Functions
def	seq_get (seq, index, default=None)
	Get element from sequence by index. More...
def	read_data (stream, urpc_type)
	Read data of given type from stream. More...
def	read_vary (stream, data_size_type="B")
	Read variable length data from stream. More...
def	write_data (stream, data, urpc_type)
	Write data of given type to stream. More...
def	write_vary (stream, data, data_size_type="B")
	Write variable length data to stream. More...

Variables
string	PROMPT_ERR_SPARE_TABLE_ITEM = "Index does not correspond to any value."
	Spare table item error prompt. More...
string	PROMPT_ERR_TABLE_FULL = "The table is full."
	Full allocation table prompt. More...
	_AllocTableItem = namedtuple("_AllocTableItem", ["spare", "next", "data"])
	Allocation table item class. More...

Function Documentation

read_data()

def urpc.util.read_data	(		stream,
			urpc_type
	)

Read data of given type from stream.

Parameters

stream	Data stream.
urpc_type	u-RPC data type.

Returns

Read data in given type.

read_vary()

def urpc.util.read_vary	(		stream,
			data_size_type = "B"
	)

Read variable length data from stream.

Parameters

stream	Data stream.
data_size_type	Type of data size in Python's struct module representation.

Returns

Data in byte array.

seq_get()

def urpc.util.seq_get	(		seq,
			index,
			default = None
	)

Get element from sequence by index.

(Fallback to default if index is out of range)

Parameters

seq	Sequence.
index	Index of the element.
default	Fallback default value.

Returns

Element if index is valid, otherwise default value.

write_data()

def urpc.util.write_data	(		stream,
			data,
			urpc_type
	)

Write data of given type to stream.

Parameters

stream	Data stream.
data	Data to write to stream.
urpc_type	u-RPC data type.

write_vary()

def urpc.util.write_vary	(		stream,
			data,
			data_size_type = "B"
	)

Write variable length data to stream.

Parameters

stream	Data stream.
data	Data to write to stream.
data_size_type	Type of data size in Python's struct module representation.

Variable Documentation

_AllocTableItem

urpc.util._AllocTableItem = namedtuple("_AllocTableItem", ["spare", "next", "data"])

private

Allocation table item class.

PROMPT_ERR_SPARE_TABLE_ITEM

string urpc.util.PROMPT_ERR_SPARE_TABLE_ITEM = "Index does not correspond to any value."

Spare table item error prompt.

PROMPT_ERR_TABLE_FULL

string urpc.util.PROMPT_ERR_TABLE_FULL = "The table is full."

Full allocation table prompt.