Struct CheckpointCoordinator 

pub struct CheckpointCoordinator { /* private fields */ }

Central checkpoint coordinator.

Manages the lifecycle of periodic checkpoints: scheduling, barrier initiation, acknowledgement collection, and storage of completed snapshots.

Implementations

impl CheckpointCoordinator

pub fn new(interval: Duration) -> Self

Create a coordinator with the given checkpoint interval.

pub fn with_max_retained(self, n: usize) -> Self

Override the maximum number of retained completed checkpoints.

pub fn with_operator_timeout(self, timeout: Duration) -> Self

Override the per-operator acknowledgement timeout.

pub fn register_operator(&mut self, operator_id: String)

Register an operator that must participate in every checkpoint.

pub fn register_operators( &mut self, operator_ids: impl IntoIterator<Item = String>, )

Register multiple operators at once.

pub fn should_checkpoint(&self) -> bool

Returns true if enough time has elapsed and no checkpoint is in progress.

pub fn initiate(&mut self) -> Result<u64, StreamError>

Initiate a new checkpoint.

The returned checkpoint_id should be forwarded to all registered operators as a barrier token.

Returns an error if a checkpoint is already in progress.

pub fn operator_reported( &mut self, snapshot: OperatorSnapshot, ) -> Result<bool, StreamError>

Called by an operator after it has snapshotted its state.

Returns true when all operators have acknowledged (checkpoint complete).

pub fn abort(&mut self, reason: &str)

Abort the in-progress checkpoint, transitioning back to Idle.

pub fn reset_to_idle(&mut self)

Reset from a Failed or Completed phase back to Idle.

pub fn latest_checkpoint(&self) -> Option<&GlobalCheckpoint>

Return a reference to the most recent completed checkpoint.

pub fn get_checkpoint(&self, id: u64) -> Option<&GlobalCheckpoint>

Return a reference to a completed checkpoint by ID.

pub fn completed_count(&self) -> usize

Number of retained completed checkpoints.

pub fn current_checkpoint_id(&self) -> Option<u64>

The checkpoint ID currently in progress, if any.

pub fn phase(&self) -> &CheckpointPhase

Current phase (for diagnostics).

pub fn pending_operators(&self) -> Option<Vec<String>>

Pending operator acknowledgements for the in-progress checkpoint.

Returns None if no checkpoint is in progress.