Struct SoftCycleController 

pub struct SoftCycleController<T: Payload = ()> { /* private fields */ }

Coordination controller for soft restarts and graceful shutdowns.

SoftCycleController exposes a tiny async-friendly coordination protocol:

• producers call try_notify to publish a notification with a payload and notify waiters;
• producers call try_clear to move back to the non-notified state;
• consumers create a SoftCycleListener via listener to wait for notifications with payloads.

See the crate-level documentation for detailed documentation and usage examples.

Implementations

impl<T: Payload> SoftCycleController<T>

pub fn new() -> Self

Creates a new SoftCycleController.

pub fn try_notify(&self, payload: T) -> Result<u32, T>

Attempts to notify. On success returns Ok(sequence_number) where the sequence number starts from 0 and increases. On failure (already notified) returns Err(payload) with the payload unchanged. Never blocks.

pub fn try_clear(&self) -> Result<u32, ()>

Clears the notified state. On success returns Ok(sequence_number) for the notification sequence number that was cleared. On failure (not currently notified) returns Err(()). Never blocks.

Clearing after a notify does not prevent listeners already waiting from receiving the notification.

pub fn listener<'a>(&'a self) -> SoftCycleListener<'a, T>

Returns a listener that resolves when a notification is observed, with Ok(payload). If already notified, it may complete in a finite number of polls; if not yet notified, it completes in a finite number of polls after the next try_notify. After multiple notify/clear cycles, the listener returns one of the payloads (no guarantee of earliest or latest). See the crate-level documentation.