Struct Generation 

pub struct Generation { /* private fields */ }

A process generation keeps admitted sessions alive until their leases drop.

Implementations

impl Generation

pub async fn run_until_retired<F, Fut>( &self, interval: Duration, staging_lifetime: Duration, refresh: F, ) -> Retirement

where F: FnMut() -> Fut, Fut: Future<Output = ()>,

Refresh application discovery until this process can retire. This loop owns session wakeups and retirement; the callback reads application selection and may invoke the shared replacement transaction.

With a drain limit, the loop also wakes when the limit passes, and checks it before and after every refresh, so no refresh starts once it has passed. A refresh callback that never completes still delays retirement.

pub fn new(own: u64, selected: u64, staged: bool) -> Self

Initialize from the persisted selection and the process’s startup record.

pub fn with_drain_limit(self, limit: Duration) -> Self

Bound how long a superseded generation waits for its session leases.

Without a limit a held lease keeps a superseded generation alive indefinitely. With one, Self::retire and Self::run_until_retired retire it once the limit has passed since a newer generation was first selected, whatever leases remain.

pub fn selected(&self) -> u64

Return the latest observed selected epoch.

pub fn select(&self, selected: u64) -> Result<()>

Observe a committed selection. Binary rollback still requires a larger epoch.

pub fn admit(self: &Arc<Self>) -> Option<SessionLease>

Admit a session unless retirement closed admission.

pub fn retire_if_idle(&self, staging_lifetime: Duration) -> bool

Retire only an idle superseded generation or expired unselected candidate.

Ignores the drain limit; see Self::retire.

pub fn retire(&self, staging_lifetime: Duration) -> Option<Retirement>

Retire an idle superseded generation or expired unselected candidate, or a superseded generation whose drain limit has passed.

pub fn snapshot(&self) -> Snapshot

Snapshot without waiting for any transport I/O.

pub fn subscribe(&self) -> Receiver<()>

Subscribe before reading state so a concurrent release is not missed.

Notifies when the selected generation advances and when a session lease is released: the transitions that can make retirement possible. Admission and SessionLease::mark_legacy do not notify, so Self::run_until_retired does not refresh once per new session.