Struct ShutdownController 

pub struct ShutdownController { /* private fields */ }

Controller for initiating and coordinating shutdown.

Create one controller per server and share it via subscribe().

Implementations

impl ShutdownController

pub fn new() -> Self

Create a new shutdown controller.

pub fn subscribe(&self) -> ShutdownReceiver

Create a receiver to wait for shutdown signals.

pub fn phase(&self) -> ShutdownPhase

Get the current shutdown phase.

pub fn is_shutting_down(&self) -> bool

Check if shutdown has been initiated.

pub fn is_forced(&self) -> bool

Check if forced shutdown was requested.

pub fn shutdown(&self)

Initiate graceful shutdown.

This begins the shutdown sequence. If shutdown is already in progress, calling this again triggers forced shutdown.

pub fn force_shutdown(&self)

Force immediate shutdown without grace period.

pub fn advance_phase(&self) -> bool

Advance to the next shutdown phase.

Returns true if the phase was advanced.

pub fn register_hook<F>(&self, hook: F)

where F: FnOnce() + Send + 'static,

Register a shutdown hook to run during the RunningHooks phase.

Hooks run in LIFO order (last registered runs first).

pub fn register_async_hook<F, Fut>(&self, hook: F)

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

Register an async shutdown hook.

pub fn pop_hook(&self) -> Option<ShutdownHook>

Pop and return the next shutdown hook to run.

Returns None when all hooks have been run.

pub fn hook_count(&self) -> usize

Returns the number of registered hooks.

pub fn track_request(&self) -> InFlightGuard

Track a new in-flight request.

Returns a guard that decrements the count when dropped.

pub fn in_flight_count(&self) -> usize

Get the current in-flight request count.

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.