Struct sfm_models::Shutdown

pub struct Shutdown { /* private fields */ }

Listens for the server shutdown signal.

Shutdown is signalled using a broadcast::Receiver. Only a single value is ever sent. Once a value has been sent via the broadcast channel, the server should shutdown.

The Shutdown struct listens for the signal and tracks that the signal has been received. Callers may query for whether the shutdown signal has been received or not.

Implementations

impl Shutdown

pub fn new(notify: Receiver<()>) -> Shutdown

Create a new Shutdown backed by the given broadcast::Receiver.

pub fn is_shutdown(&self) -> bool

Returns true if the shutdown signal has been received.

pub fn shutdown(&mut self)

pub async fn recv(&mut self)

Receive the shutdown notice, waiting if necessary.

pub async fn watchdog(&mut self, notifier: Sender<()>)

Trait Implementations

impl Debug for Shutdown

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

Formats the value using the given formatter.