Struct trillium_server_common::ServerHandle

pub struct ServerHandle { /* private fields */ }

A handle for a spawned trillium server. Returned by Config::handle and Config::spawn

Implementations

impl ServerHandle

pub async fn info(&self) -> Info

await server start and retrieve the server’s [Info]

pub async fn stop(&self)

stop server and wait for it to shut down gracefully

pub fn stopper(&self) -> Stopper

retrieves a clone of the Stopper used by this server

pub fn observer(&self) -> CloneCounterObserver

retrieves a CloneCounterObserver which can be used to monitor or modify the number of outstanding connections for the purposes of graceful shutdown.

pub fn is_running(&self) -> bool

checks whether this server has shut down. It’s preferable to await this ServerHandle instead of polling this.

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.

impl Debug for ServerHandle

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

Formats the value using the given formatter.

impl IntoFuture for ServerHandle

type Output = ()

The output that the future will produce on completion.

type IntoFuture = CompletionFuture

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.