Struct xaynet_server::state_machine::initializer::StateMachineInitializer

pub struct StateMachineInitializer<C, M> where
    C: CoordinatorStorage,
    M: ModelStorage,  { /* fields omitted */ }

The state machine initializer that initializes a new state machine.

Implementations

impl<C, M> StateMachineInitializer<C, M> where
    C: CoordinatorStorage,
    M: ModelStorage, 

pub fn new(
    pet_settings: PetSettings,
    mask_settings: MaskSettings,
    model_settings: ModelSettings,
    #[cfg(feature = "model-persistence")] restore_settings: RestoreSettings,
    store: Store<C, M>
) -> Self

Creates a new StateMachineInitializer.

impl<C, M> StateMachineInitializer<C, M> where
    C: CoordinatorStorage,
    M: ModelStorage, 

pub async fn init(
    self
) -> Result<(StateMachine<C, M>, RequestSender, EventSubscriber), StateMachineInitializationError>

This is supported on crate feature model-persistence only.

Initializes a new StateMachine by trying to restore the previous coordinator state along with the latest global model. After a successful initialization, the state machine always starts from a new round. This means that the round id is increased by one. If the state machine is reset during the initialization, the state machine starts with the round id 1.

Behavior

• If the [RestoreSettings.enable] flag is set to false, the current coordinator state will be reset and a new StateMachine is created with the given settings.
• If no coordinator state exists, the current coordinator state will be reset and a new StateMachine is created with the given settings.
• If a coordinator state exists but no global model has been created so far, the StateMachine will be restored with the coordinator state but without a global model.
• If a coordinator state and a global model exists, the StateMachine will be restored with the coordinator state and the global model.
• If a global model has been created but does not exists, the initialization will fail with StateMachineInitializationError::GlobalModelUnavailable.
• If a global model exists but its properties do not match the coordinator model settings, the initialization will fail with StateMachineInitializationError::GlobalModelInvalid.
• Any network error will cause the initialization to fail.