Struct salvo_core::server::ServerHandle

pub struct ServerHandle { /* private fields */ }

Available on crate feature server only.

Server handle is used to stop server.

Implementations

impl ServerHandle

pub fn stop_forcible(&self)

Force stop server.

Call this function will stop server immediately.

pub fn stop_graceful(&self, timeout: impl Into<Option<Duration>>)

Graceful stop server.

Call this function will stop server after all connections are closed, allowing it to finish processing any ongoing requests before terminating. It ensures that all connections are closed properly and any resources are released.

You can specify a timeout to force stop server. If timeout is None, it will wait util all connections are closed.

This function gracefully stop the server, allowing it to finish processing any ongoing requests before terminating. It ensures that all connections are closed properly and any resources are released.

Examples

use salvo_core::prelude::*;

#[tokio::main]
async fn main() {
    let acceptor = TcpListener::new("127.0.0.1:5800").bind().await;
    let server = Server::new(acceptor);
    let handle = server.handle();

    // Graceful shutdown the server
      tokio::spawn(async move {
        tokio::time::sleep(std::time::Duration::from_secs(60)).await;
        handle.stop_graceful(None);
    });
    server.serve(Router::new()).await;
}

Trait Implementations

impl Clone for ServerHandle

fn clone(&self) -> ServerHandle

Returns a copy of the value.

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

Performs copy-assignment from source.