Struct ShutdownCoordinator 

pub struct ShutdownCoordinator { /* private fields */ }

Coordinates graceful shutdown of agent workloads.

The shutdown coordinator manages a state machine with three states:

• Running: Normal operation, new work can be registered
• Draining: Shutdown initiated, no new work accepted, existing work completes
• Terminated: All work completed or timeout expired

Example

let coordinator = Arc::new(ShutdownCoordinator::new(Duration::from_secs(30)));
let guard = coordinator.register_work();
// ... do work ...
drop(guard); // Work completes

coordinator.shutdown().await.unwrap();
assert_eq!(coordinator.state(), ShutdownState::Terminated);

Implementations

impl ShutdownCoordinator

pub fn new(drain_timeout: Duration) -> Self

Creates a new shutdown coordinator with the specified drain timeout.

Arguments

• drain_timeout - Maximum duration to wait for in-flight work to complete

pub fn register_work(self: &Arc<Self>) -> ShutdownResult<WorkGuard>

Registers a unit of in-flight work.

Returns a WorkGuard that automatically decrements the in-flight counter when dropped. If shutdown is already in progress, returns an error.

Errors

Returns ShutdownError::AlreadyShuttingDown if shutdown has been initiated.

pub async fn shutdown(&self) -> ShutdownResult<()>

Initiates graceful shutdown.

Transitions the coordinator to Draining state and waits for in-flight work to complete up to the configured drain timeout. If the timeout expires, returns an error but still transitions to Terminated.

Errors

Returns ShutdownError::DrainTimeout if in-flight work doesn’t complete within the drain timeout.

pub fn state(&self) -> ShutdownState

Returns the current shutdown state.

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

Subscribes to shutdown signal.

Returns a receiver that will be notified when shutdown is initiated.

pub fn in_flight_count(&self) -> u32

Returns the number of in-flight work items.

Trait Implementations

impl Debug for ShutdownCoordinator

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

Formats the value using the given formatter.