Struct GracefulShutdownSignal 

pub struct GracefulShutdownSignal { /* private fields */ }

Notification that the server has started a graceful shutdown.

The signal remains notified after graceful shutdown starts. A listener that calls notified or clones this signal after that point is notified immediately. A forced shutdown does not notify this signal.

Server State

When this signal is notified, the Server has accepted a graceful shutdown command, but shutdown is not complete. The server sends this notification before it tells the accept loop and workers to stop. Therefore, a listener can briefly overlap with connection acceptance and normal worker operation.

Very shortly after notification, the server stops accepting connections and tells each worker to stop its services. Active service futures can continue until they finish or the ServerBuilder::shutdown_timeout expires.

Use Cases

Connection-oriented services can listen to this signal to coordinate their own drain process. For example, a protocol dispatcher can:

• close an idle persistent connection;
• stop accepting new logical requests on an active connection;
• let the current request or protocol operation finish; and
• start a protocol-specific close handshake or flush buffered data.

This signal does not replace the worker shutdown timeout. A listener must still finish its service future for the worker to complete a graceful shutdown.

Implementations

impl GracefulShutdownSignal

pub async fn notified(&self)

Resolves when the server starts a graceful shutdown, or immediately if graceful shutdown has already started.

Trait Implementations

impl Clone for GracefulShutdownSignal

fn clone(&self) -> GracefulShutdownSignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GracefulShutdownSignal

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

Formats the value using the given formatter.