openpectus.protocol.aggregator_messages

Attributes

`SuccessMessage`
`ErrorMessage`

Classes

`AggregatorMessage`	Marker class that indicates a protocol message sent by Aggregator to Engine.
`RegisterEngineReplyMsg`	Reply to a RegisterEngineMsg from engine.
`ExecuteControlCommandMsg`	Request from user to invoke a command.
`InjectCodeMsg`	Request from user to inject pcode.
`MethodMsg`	Request from user to set a new method to be executed by engine.
`CancelMsg`	Request from user to cancel an instruction.
`ForceMsg`	Request from user to force an instruction to start.

Module Contents

openpectus.protocol.aggregator_messages.SuccessMessage

openpectus.protocol.aggregator_messages.ErrorMessage

class openpectus.protocol.aggregator_messages.AggregatorMessage(/, **data)

Bases: openpectus.protocol.messages.MessageBase

Marker class that indicates a protocol message sent by Aggregator to Engine.

On the Engine side, they are handled by EngineMessageHandlers.

Parameters:: data (Any)

class openpectus.protocol.aggregator_messages.RegisterEngineReplyMsg(/, **data)

Bases: AggregatorMessage

Reply to a RegisterEngineMsg from engine.

Parameters:: data (Any)

success: bool

engine_id: str | None = None

secret_match: bool

__str__()

Return type:: str

class openpectus.protocol.aggregator_messages.ExecuteControlCommandMsg(/, **data)

Bases: AggregatorMessage

Request from user to invoke a command.

Parameters:: data (Any)

name: str = ''

__str__()

Return type:: str

class openpectus.protocol.aggregator_messages.InjectCodeMsg(/, **data)

Bases: AggregatorMessage

Request from user to inject pcode.

Parameters:: data (Any)

pcode: str

__str__()

Return type:: str

class openpectus.protocol.aggregator_messages.MethodMsg(/, **data)

Bases: AggregatorMessage

Request from user to set a new method to be executed by engine.

Parameters:: data (Any)

method: openpectus.protocol.models.Method

__str__()

Return type:: str

class openpectus.protocol.aggregator_messages.CancelMsg(/, **data)

Bases: AggregatorMessage

Request from user to cancel an instruction.

Parameters:: data (Any)

exec_id: str

__str__()

Return type:: str

class openpectus.protocol.aggregator_messages.ForceMsg(/, **data)

Bases: AggregatorMessage

Request from user to force an instruction to start.

Parameters:: data (Any)

exec_id: str

__str__()

Return type:: str