Struct Shutdown 

pub struct Shutdown { /* private fields */ }

CancellationToken wrapper

Implementations

impl Shutdown

pub fn manual<F>(on_graceful_shutdown: F) -> Self

where F: FnOnce() + Send + 'static,

pub fn watch_signal<Fut, F>(signal: Fut, on_graceful_shutdown: F) -> Self

where F: FnOnce() + Send + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

When the given signal Future is resolved, call the cancel method of the held CancellationToken.

pub fn shutdown(&self)

Request shutdown

pub fn shutdown_with_reason(&self, reason: ShutdownReason)

pub fn reason(&self) -> Option<ShutdownReason>

pub fn is_shutdown_requested(&self) -> bool

pub fn into_handle(self) -> Handle<SocketAddr>

pub fn cancellation_token(&self) -> CancellationToken

Return CancellationToken which is cancelled at shutdown

Trait Implementations

impl Clone for Shutdown

fn clone(&self) -> Shutdown

Returns a duplicate of the value.

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

Performs copy-assignment from source.