Struct ShutdownManager 

pub struct ShutdownManager { /* private fields */ }

A manager for coordinating the graceful shutdown of background tasks.

Implementations

impl ShutdownManager

pub fn new() -> Self

Creates a new ShutdownManager.

pub fn spawn_task<F>(&mut self, task: F)

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

Spawns a new task that will be managed by the shutdown coordinator.

The provided future will be spawned onto the Tokio runtime. The task must be Send and 'static because it may outlive the current scope.

If the ShutdownManager is dropped, all tasks spawned by it are immediately aborted.

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

Returns a new receiver for the shutdown signal.

Each background task should subscribe to this signal to know when to begin its graceful termination.

pub fn abort_all(&mut self)

Immediately aborts all tasks managed by the ShutdownManager.

This is a forced shutdown and does not wait for tasks to complete their cleanup. It is useful for situations where a quick, non-graceful termination is required.

pub async fn graceful_shutdown( self, timeout: Duration, ) -> Result<(), ShutdownError>

Initiates a graceful shutdown of all managed tasks.

This method first broadcasts the shutdown signal. It then waits for all tasks to complete, up to the specified timeout.

This method consumes the ShutdownManager, preventing it from being used again.

Returns Ok(()) if all tasks shut down cleanly within the timeout. Returns Err(ShutdownError) if a task panicked or if the timeout is reached.

Trait Implementations

impl Default for ShutdownManager

fn default() -> Self

Returns the “default value” for a type.