Enum ShutdownEvent 

#[non_exhaustive]
pub enum ShutdownEvent {
    Draining {
        active_connections: usize,
        drain_timeout: Option<Duration>,
    },
    DrainTimedOut {
        remaining_connections: usize,
    },
}

An event emitted during graceful shutdown.

Register a handler with ServerBuilder::on_shutdown_event to receive these. When no handler is registered, the server logs via tracing::warn by default.

Example

use icap_rs::{IcapResult, Server, ShutdownEvent};

#[tokio::main]
async fn main() -> IcapResult<()> {
    let server = Server::builder()
        .bind("127.0.0.1:1344")
        .on_shutdown_event(|event| match event {
            ShutdownEvent::Draining { active_connections, drain_timeout } => {
                eprintln!("shutting down: {active_connections} connections in flight");
                if let Some(d) = drain_timeout {
                    eprintln!("force-close in {d:.1?}");
                }
            }
            ShutdownEvent::DrainTimedOut { remaining_connections } => {
                eprintln!("drain timed out, cancelling {remaining_connections} connections");
            }
            _ => {}
        })
        .build()
        .await?;

    server.run_until(async { tokio::signal::ctrl_c().await.ok(); }).await
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Draining

Shutdown signal received; drain phase starting.

New connections are refused with 503 Service Unavailable. active_connections are still processing requests. If drain_timeout is set, remaining connections will be force-cancelled after it expires.

Fields

active_connections: usize

Number of connections still in flight.

drain_timeout: Option<Duration>

How long until in-flight connections are force-cancelled, if configured.

DrainTimedOut

Drain deadline expired; remaining connections are being cancelled.

Fields

remaining_connections: usize

Number of connections that are being cancelled.

Trait Implementations

impl Clone for ShutdownEvent

fn clone(&self) -> ShutdownEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ShutdownEvent

impl Debug for ShutdownEvent

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

Formats the value using the given formatter.