Struct Handle

pub struct Handle { /* private fields */ }

A handle to manage and interact with the server.

Handle provides methods to access server information, such as the number of active connections, and to perform actions like initiating a shutdown.

Implementations

impl Handle

pub fn new() -> Self

Create a new handle for the server.

Returns

A new Handle instance.

Examples found in repository

examples/shutdown.rs (line 16)

async fn main() {
    let app = Router::new().route("/", get(|| async { "Hello, world!" }));

    let handle = Handle::new();

    // Spawn a task to shutdown server.
    tokio::spawn(shutdown(handle.clone()));

    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
    println!("listening on {}", addr);
    hyper_server::bind(addr)
        .handle(handle)
        .serve(app.into_make_service())
        .await
        .unwrap();

    println!("server is shut down");
}

examples/graceful_shutdown.rs (line 19)

async fn main() {
    let app = Router::new().route("/", get(|| async { "Hello, world!" }));

    let handle = Handle::new();

    // Spawn a task to gracefully shutdown server.
    tokio::spawn(graceful_shutdown(handle.clone()));

    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
    println!("listening on {}", addr);
    hyper_server::bind(addr)
        .handle(handle)
        .serve(app.into_make_service())
        .await
        .unwrap();

    println!("server is shut down");
}

pub fn connection_count(&self) -> usize

Get the number of active connections to the server.

Returns

The number of active connections.

Examples found in repository

examples/graceful_shutdown.rs (line 48)

async fn graceful_shutdown(handle: Handle) {
    // Wait 10 seconds.
    sleep(Duration::from_secs(10)).await;

    println!("sending graceful shutdown signal");

    // Signal the server to shutdown using Handle.
    handle.graceful_shutdown(Some(Duration::from_secs(30)));

    // Print alive connection count every second.
    loop {
        sleep(Duration::from_secs(1)).await;

        println!("alive connections: {}", handle.connection_count());
    }
}

pub fn shutdown(&self)

Initiate an immediate shutdown of the server.

This method will terminate the server without waiting for active connections to close.

Examples found in repository

examples/shutdown.rs (line 39)

async fn shutdown(handle: Handle) {
    // Wait 20 seconds.
    sleep(Duration::from_secs(20)).await;

    println!("sending shutdown signal");

    // Signal the server to shutdown using Handle.
    handle.shutdown();
}

pub fn graceful_shutdown(&self, duration: Option<Duration>)

Initiate a graceful shutdown of the server.

The server will wait for active connections to close before shutting down. If a duration is provided, the server will wait up to that duration for active connections to close before forcing a shutdown.

Parameters

• duration: Maximum time to wait for active connections to close. None means the server will wait indefinitely.

Examples found in repository

examples/graceful_shutdown.rs (line 42)

async fn graceful_shutdown(handle: Handle) {
    // Wait 10 seconds.
    sleep(Duration::from_secs(10)).await;

    println!("sending graceful shutdown signal");

    // Signal the server to shutdown using Handle.
    handle.graceful_shutdown(Some(Duration::from_secs(30)));

    // Print alive connection count every second.
    loop {
        sleep(Duration::from_secs(1)).await;

        println!("alive connections: {}", handle.connection_count());
    }
}

pub async fn listening(&self) -> Option<SocketAddr>

Wait until the server starts listening and then returns its local address and port.

Returns

The local SocketAddr if the server successfully binds, otherwise None.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Handle

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

Formats the value using the given formatter.

impl Default for Handle

fn default() -> Handle

Returns the “default value” for a type.