Struct ShutdownController 

pub struct ShutdownController { /* private fields */ }

Shutdown controller that manages graceful shutdown

This is the central coordinator for shutdown operations. Clone this to share across tasks.

Implementations

impl ShutdownController

pub fn new() -> Self

Create a new shutdown controller with default settings

pub fn with_timeout(drain_timeout: Duration) -> Self

Create a new shutdown controller with custom drain timeout

pub fn is_shutting_down(&self) -> bool

Check if shutdown has been initiated

pub fn state(&self) -> ShutdownState

Get the current shutdown state

pub fn state_receiver(&self) -> Receiver<ShutdownState>

Get a receiver for state changes

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

Subscribe to shutdown notifications

pub async fn initiate_shutdown(&self)

Initiate graceful shutdown

This method:

1. Sets the shutdown flag
2. Transitions to Draining state
3. Notifies all subscribers
4. Waits for connections to drain (with timeout)
5. Transitions to Stopped state

pub async fn wait_for_shutdown(&self)

Wait for the shutdown signal

pub fn connection_start(&self)

Increment active connection count

pub fn connection_end(&self)

Decrement active connection count

pub fn active_connections(&self) -> u64

Get current active connection count

pub fn connection_guard(&self) -> ConnectionGuard

Create a connection guard that automatically decrements on drop

pub fn drain_timeout(&self) -> Duration

Get the drain timeout

pub fn shutdown_elapsed(&self) -> Option<Duration>

Get time elapsed since shutdown started

pub fn retry_after_secs(&self) -> u64

Get Retry-After header value in seconds (for 503 responses)

impl ShutdownController

pub fn health_status(&self) -> HealthStatus

Get health status for health check endpoint

During shutdown, this returns unhealthy status with retry information.

Trait Implementations

impl Clone for ShutdownController

fn clone(&self) -> ShutdownController

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ShutdownController

fn default() -> Self

Returns the “default value” for a type.