pub enum LocalState {
Unknown,
Observation(Observation),
Leadership(Leadership),
}Expand description
Optional caller-owned helper holding the local anchors between polls.
No variant is persisted or transferable to another process incarnation.
Its anchors are readings of the caller’s monotonic clock. Build each
poll’s PollInput with Self::input, then replace it with
Self::adopt only after the enclosing
Database::run succeeds.
Variants§
Unknown
No durable state has been adopted by this caller.
Observation(Observation)
An exact durable owner record this caller is not authorized to renew.
The preserved observation time can permit a conditional takeover only if a later poll sees the same owner, revision, and lease duration.
Leadership(Leadership)
The exact durable owner record this caller may attempt to renew locally.
It does not prove current durable ownership. A later poll must still match the record and find this caller’s local lease interval unexpired.
Implementations§
Source§impl LocalState
impl LocalState
Sourcepub fn unknown() -> Self
pub fn unknown() -> Self
Returns the initial state for a caller that has not adopted a poll result.
Sourcepub fn input(&self, now: Duration) -> PollInput
pub fn input(&self, now: Duration) -> PollInput
Returns the poll input claiming this state, with elapsed time measured to now.
now is a reading of the caller’s monotonic clock taken before the
enclosing Database::run. Keep the same input
for every retry attempt of that run. Elapsed time saturates at zero if
now precedes the anchor.
Sourcepub fn adopt(
self,
attempt_started_at: Duration,
adopted_at: Duration,
next: &NextState,
) -> Self
pub fn adopt( self, attempt_started_at: Duration, adopted_at: Duration, next: &NextState, ) -> Self
Anchors a committed poll’s NextState and returns the state for the next poll.
Call it only after the enclosing Database::run
succeeds. attempt_started_at is the reading passed to Self::input
for that run and adopted_at a fresh reading taken after it succeeded.
- Leadership is anchored at
attempt_started_at, before the durable read, so read, retry, and commit delay only shorten local validity. - A reset observation is anchored at
adopted_at, so its timer starts only once its durable read is known to have committed. - A preserved observation keeps this state’s anchor when this state is the same observation, and otherwise falls back to a reset.
Sourcepub fn observation(&self) -> Option<&Observation>
pub fn observation(&self) -> Option<&Observation>
Returns the adopted observation, if this caller is following an owner.
None means either no state has been adopted or this caller holds a
local leadership token. It does not query durable state.
Sourcepub fn leadership(&self) -> Option<&Leadership>
pub fn leadership(&self) -> Option<&Leadership>
Returns the adopted local leadership token, if any.
It is not proof that the caller remains the durable owner. Poll with
Self::input. To resign, pass this caller’s own participant with
Leadership::rank and Leadership::lease_duration to
super::LeaderElection::resign.
Trait Implementations§
Source§impl Clone for LocalState
impl Clone for LocalState
Source§fn clone(&self) -> LocalState
fn clone(&self) -> LocalState
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more