Struct xaynet_mobile::Participant

pub struct Participant { /* fields omitted */ }

A participant. It embeds an internal state machine that executes the PET protocol. However, it is the caller's responsibility to drive this state machine by calling Participant::tick(), and to take action when the participant state changes.

Implementations

impl Participant

pub fn new(settings: Settings) -> Result<Self, InitError>

Create a new participant with the given settings

pub fn restore(state: &[u8], url: &str) -> Result<Self, InitError>

Restore a participant from it's serialized state. The coordinator client that the participant uses internally is not part of the participant state, so the url is used to instantiate a new one.

pub fn save(self) -> Vec<u8>

Serialize the participant state and return the corresponding buffer.

pub fn tick(&mut self)

Drive the participant internal state machine.

After calling this method, the caller should check whether the participant state changed, by calling Participant::made_progress(). If the state changed, the caller should perform the following checks and react appropriately:

• whether the participant is taking part to any task by calling Participant::task()
• whether the participant should load its model into the store by calling Participant::should_set_model()

pub fn made_progress(&self) -> bool

Check whether the participant internal state machine made progress while executing the PET protocol. If so, the participant state likely changed.

pub fn should_set_model(&self) -> bool

Check whether the participant internal state machine is waiting for the participant to load its model into the store. If this method returns true, the caller should make sure to call Participant::set_model() at some point.

pub fn new_global_model(&self) -> bool

Check whether a new global model is available. If this method returns true, the caller can call Participant::global_model() to fetch the new global model.

pub fn task(&self) -> Task

Return the participant current task

pub fn set_model(&mut self, model: Model)

Load the given model into the store, so that the participant internal state machine can process it.

pub fn global_model(&mut self) -> Result<Option<Model>, GetGlobalModelError>

Retrieve the current global model, if available.

pub fn local_model_config(&self) -> LocalModelConfig

Return the local model configuration of the model that is expected in the Participant::set_model method.