Struct ServerHandle 

pub struct ServerHandle { /* private fields */ }

Background-task handle returned by every spawn_* method.

Drop semantics: dropping the handle does not stop the server. Call ServerHandle::shutdown (or ServerHandle::trigger + .join().await) so the drain logic in the underlying serve_*_with_shutdown runs.

Runtime-agnostic — the done signal is fired by an async wrapper around the underlying serve_* future, so the same ServerHandle works whether the spawned task lives on the tokio runtime or the compio runtime.

Implementations

impl ServerHandle

pub fn trigger(&self)

Trigger graceful shutdown without awaiting completion.

pub async fn join(&self)

Await the spawned task’s completion (without triggering shutdown).

Returns when the underlying serve_* future resolves — typically because ServerHandle::trigger / ServerHandle::shutdown was called or because the listener errored fatally.

pub async fn shutdown(self, _timeout: Duration)

Trigger graceful shutdown and await the drain.

The _timeout argument is kept for API symmetry with the original builder; the actual drain bound is the drain_timeout on the ServerConfig that was handed to the builder, enforced inside serve_*_with_shutdown.

pub fn drain_timeout(&self) -> Duration

Returns the drain timeout the underlying serve_* will honor.

Trait Implementations

impl Debug for ServerHandle

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

Formats the value using the given formatter.