Enum xaynet_sdk::StateMachine

pub enum StateMachine {
    NewRound(Phase<NewRound>),
    Awaiting(Phase<Awaiting>),
    Sum(Phase<Sum>),
    Update(Phase<Update>),
    Sum2(Phase<Sum2>),
    SendingSum(Phase<SendingSum>),
    SendingUpdate(Phase<SendingUpdate>),
    SendingSum2(Phase<SendingSum2>),
}

PET state machine.

Variants

NewRound(Phase<NewRound>)

PET state machine in the "new round" phase

Awaiting(Phase<Awaiting>)

PET state machine in the "awaiting" phase

Sum(Phase<Sum>)

PET state machine in the "sum" phase

Update(Phase<Update>)

PET state machine in the "update" phase

Sum2(Phase<Sum2>)

PET state machine in the "sum2" phase

SendingSum(Phase<SendingSum>)

PET state machine in the "sending sum message" phase

SendingUpdate(Phase<SendingUpdate>)

PET state machine in the "sending update message" phase

SendingSum2(Phase<SendingSum2>)

PET state machine in the "sending sum2 message" phase

Implementations

impl StateMachine

pub async fn transition(self) -> TransitionOutcome

Try to make progress in the PET protocol

pub fn save(self) -> SerializableState

Convert the state machine into a serializable data structure so that it can be saved.

pub fn local_model_config(&self) -> LocalModelConfig

Return the local model configuration of the model that is expected in the update phase.

impl StateMachine

pub fn new<X, M, N>(
    settings: PetSettings,
    xaynet_client: X,
    model_store: M,
    notifier: N
) -> Self where
    X: XaynetClient + Send + 'static,
    M: ModelStore + Send + 'static,
    N: Notify + Send + 'static, 

Instantiate a new PET state machine.

Args

• settings: PET settings
• xaynet_client: a client for communicating with the Xaynet coordinator
• model_store: a store from which the trained model can be loaded, when the participant is selected for the update task
• notifier: a type that the state machine can use to emit notifications

pub fn restore<X, M, N>(
    state: SerializableState,
    xaynet_client: X,
    model_store: M,
    notifier: N
) -> Self where
    X: XaynetClient + Send + 'static,
    M: ModelStore + Send + 'static,
    N: Notify + Send + 'static, 

Restore the PET state machine from the given state.

Trait Implementations

impl Debug for StateMachine

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.