spreadflow_core.format module

Message formats for IPC.

class spreadflow_core.format.JsonMessageBuilder

Bases: object

Message builder for the JSON lines stream format.

message(msg)
class spreadflow_core.format.JsonMessageParser(buffer_max_len=32768)

Bases: object

Message parser for the JSON lines stream format.

Parameters:buffer_max_len (int) – The maximum number of bytes buffered while parsing a stream of incoming messages. Defaults to 32768.
MAX_LENGTH = 32768
messages()

Iterate over all available messages.

Yields:object – The next decoded message.
push(data)

Push data onto the message parser buffer.

Parameters:
  • data (bytes) – Data as received from the network. Partial messages
  • allowed. (are) –
Raises:

RuntimeError – If the buffer is full.
class spreadflow_core.format.PickleMessageBuilder(protocol=2)

Bases: object

Message builder for the pickle stream format.

message(msg)
class spreadflow_core.format.PickleMessageParser(buffer_max_len=32768)

Bases: object

Message parser for the pickle stream format.

Parameters:buffer_max_len (int) – The maximum number of bytes buffered while parsing a stream of incoming messages. Defaults to 32768.
HEADER_MAX_LEN = 24
MAX_LENGTH = 32768
messages()

Iterate over all available messages.

Yields:object – The next decoded message.
push(data)

Push data onto the message parser buffer.

Parameters:
  • data (bytes) – Data as received from the network. Partial messages
  • allowed. (are) –
Raises:

RuntimeError – If the buffer is full.