`kosmos.protocols.protocol`¶

Classes¶

class Protocol(config: kosmos.protocols.config.protocol.ProtocolConfig, network: kosmos.topology.net.Network)[source]¶

Bases: abc.ABC

Base class for all protocols.

config¶

Protocol configuration.

Type:: ProtocolConfig

network¶

The network topology.

Type:: Network

status¶

Current status of the protocol.

Type:: ProtocolStatus

Initialize the protocol.

Parameters:

config (ProtocolConfig) – Protocol configuration.
network (Network) – The network topology.

Methods

execute() → kosmos.protocols.protocol_result.ProtocolResult[source]¶

Execute the protocol.

Returns:: Result of the protocol execution.
Return type:: ProtocolResult