Skip to main content

GroupStateMachine

Struct GroupStateMachine 

Source
pub struct GroupStateMachine { /* private fields */ }
Expand description

State machine for managing group steward epoch flow.

Implementations§

Source§

impl GroupStateMachine

Source

pub fn new_as_member() -> Self

Create a new group state machine (not steward) with default config.

Source

pub fn new_as_member_with_config(config: GroupConfig) -> Self

Create a new group state machine (not steward) with custom config.

Source

pub fn new_as_steward() -> Self

Create a new group state machine as steward with default config.

Source

pub fn new_as_steward_with_config(config: GroupConfig) -> Self

Create a new group state machine as steward with custom config.

Source

pub fn new_as_pending_join() -> Self

Create a new group state machine in PendingJoin state with default config.

Source

pub fn new_as_pending_join_with_config(config: GroupConfig) -> Self

Create a new group state machine in PendingJoin state with custom config.

Source

pub fn current_state(&self) -> GroupState

Get the current state.

Source

pub fn is_steward(&self) -> bool

Check if this is a steward state machine.

Source

pub fn set_steward(&mut self, is_steward: bool)

Set steward status.

Source

pub fn start_working(&mut self)

Start working state.

Source

pub fn start_waiting(&mut self)

Start waiting state.

Source

pub fn start_leaving(&mut self)

Transition to Leaving state.

Caller must ensure valid state transition (typically from Working or Waiting). The User::leave_group method handles PendingJoin and Leaving states separately.

Source

pub fn is_pending_join_expired(&self) -> bool

Check if the pending join has expired (time-based).

Expiration happens when ~2 epoch durations have passed since join attempt. If the member hasn’t received a welcome by then, assume rejection.

Source

pub fn is_commit_timed_out(&self) -> bool

Check if the commit has timed out while in Waiting state.

Returns true if the member has been in Waiting for longer than epoch_duration / 2 without receiving a commit from the steward.

Source

pub fn sync_epoch_boundary(&mut self)

Sync the epoch boundary to now. Called when a commit or welcome (for joining) is received. This is the synchronization point between steward and member epochs.

Source

pub fn check_epoch_boundary(&mut self, approved_proposals_count: usize) -> bool

Check if we’ve reached the expected epoch boundary and should enter Waiting.

Called by the member epoch timer. Returns true if entering Waiting state (meaning a commit timeout should be started).

§Arguments
  • approved_proposals_count - Number of approved proposals waiting for commit
§Returns

true if transitioned to Waiting state, false otherwise.

Source

pub fn time_until_next_boundary(&self) -> Option<Duration>

Get the time until the next expected epoch boundary. Returns None if no epoch boundary has been set yet.

Source

pub fn start_steward_epoch(&mut self) -> Result<(), StateMachineError>

Start steward epoch with state validation.

§Errors
  • If not in Working state
  • If not a steward

Trait Implementations§

Source§

impl Clone for GroupStateMachine

Source§

fn clone(&self) -> GroupStateMachine

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GroupStateMachine

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GroupStateMachine

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Classify for T

Source§

type Classified = T

Source§

fn classify(self) -> T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Declassify for T

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more