Skip to content

Overview

TODO: details of the base module structure and function.

state_interface - base interface for FSM creation.

state_interface

Classes:

Name Description
StateInterface

Basic FSM interface for Broker, Node, Storage.

StateInterface

Bases: ABC

Basic FSM interface for Broker, Node, Storage.

Methods:

Name Description
is_continue

Check if to stay in the current state.

kill

Trigger to enter the KILL state from any other.

run

Run the logic of the currently selected state.

is_continue abstractmethod

is_continue() -> bool

Check if to stay in the current state.

Returns:

Name Type Description
bool bool

Whether to stay in the same state.

kill abstractmethod

kill() -> None

Trigger to enter the KILL state from any other.

run abstractmethod

run() -> None

Run the logic of the currently selected state.