Struct sfm_sdk::SysSigReceiver

pub struct SysSigReceiver { /* private fields */ }

Listens for the machine shutdown signals via a SysSigListener with a broadcast::Receiver.

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 SysSigReceiver

pub fn new(shutdown: Arc<AtomicBool>, notify: Receiver<()>) -> SysSigReceiver

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 async fn recv(&mut self)

Receive the shutdown notice, waiting if necessary.

Trait Implementations

impl Debug for SysSigReceiver

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

Formats the value using the given formatter.