Struct ShutdownHandle 

pub struct ShutdownHandle { /* private fields */ }

Available on crate feature server only.

Handle for triggering graceful server shutdown.

Returned by ServerBuilder::build_with_shutdown. Pass the future from ShutdownHandle::signal() to axum::serve(...).with_graceful_shutdown() to enable both OS signal-based and HTTP endpoint-based shutdown.

Example

use adk_server::{ServerBuilder, ServerConfig};

let (app, shutdown_handle) = ServerBuilder::new(config)
    .enable_shutdown_endpoint()
    .build_with_shutdown();

let listener = tokio::net::TcpListener::bind("0.0.0.0:8080").await?;
axum::serve(listener, app)
    .with_graceful_shutdown(shutdown_handle.signal())
    .await?;

Implementations

impl ShutdownHandle

pub fn shutdown(&self)

Trigger graceful shutdown programmatically.

This has the same effect as calling POST /api/shutdown — the server stops accepting new connections and completes in-flight requests.

pub async fn signal(self)

Returns a future that resolves when shutdown is triggered.

Combines OS signals (Ctrl+C, SIGTERM) with the programmatic/HTTP trigger. Pass this to axum::serve(...).with_graceful_shutdown().

pub fn is_shutdown(&self) -> bool

Returns whether shutdown has been triggered.

Trait Implementations

impl Clone for ShutdownHandle

fn clone(&self) -> ShutdownHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.