Struct ShutdownCoordinator 

pub struct ShutdownCoordinator { /* private fields */ }

Owns the Tokio adapter task set for one application runtime.

Implementations

impl ShutdownCoordinator

pub fn new( shutdown_deadline: ShutdownDeadline, task_join_deadline: TaskJoinDeadline, telemetry_deadline: TelemetryFlushDeadline, ) -> Result<Self, ShutdownError>

Constructs an empty application-owned coordinator.

Errors

Returns ShutdownError::TaskJoinExceedsShutdown when the supplied join budget exceeds the total correctness budget.

pub fn with_event_sink(self, sink: Arc<dyn TelemetryEventSink>) -> Self

Attaches a non-authoritative, panic-isolated telemetry sink.

pub fn signal(&self) -> ShutdownSignal

Returns the application-owned handle used by API or signal adapters.

pub fn spawn<F>( &mut self, phase: ShutdownTaskPhase, future: F, ) -> Result<(), ShutdownError>

where F: Future<Output = ()> + Send + 'static,

Spawns one task into the coordinator’s structured ownership set.

Panics are caught at this boundary and counted in the shutdown report. The coordinator never detaches or force-aborts an in-flight task.

Errors

Returns ShutdownError::ShuttingDown after intake stops.

pub async fn shutdown<P, PF, T, TF, C, CF>( &mut self, persist: P, flush_telemetry: T, close_repository: C, ) -> ShutdownReport

where P: FnOnce() -> PF, PF: Future<Output = Result<(), ShutdownHookError>>, T: FnOnce() -> TF, TF: Future<Output = Result<u64, ShutdownHookError>>, C: FnOnce() -> CF, CF: Future<Output = Result<(), ShutdownHookError>>,

Runs the fixed shutdown sequence.

The persistence closure runs after joining, telemetry uses its separate deadline, and repository close runs last. Closure errors are reported without changing the previously established drain result. The persistence closure must enforce its repository statement and commit timeouts; this coordinator never cancels an in-flight persistence future at the outer correctness deadline.

Trait Implementations

impl Debug for ShutdownCoordinator

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

Formats the value using the given formatter.

impl Default for ShutdownCoordinator

fn default() -> Self

Returns the “default value” for a type.