Struct tokio_utils::ShutdownMonitor

pub struct ShutdownMonitor { /* private fields */ }

A ShutdownMonitor listens for the shutdown signal from a ShutdownController and tracks that the signal has been received.

Callers may query for whether the shutdown signal has been received or not.

Examples

use shutdown_async::ShutdownMonitor;

async fn run(monitor: &mut ShutdownMonitor) {
  while !monitor.is_shutdown() {
      tokio::select! {
       _ = monitor.recv() => { println!("shutdown initiated"); }
       _ = async { /* do work */ } => { println!("one year has passed!"); }
      }
  }
}

Implementations

impl ShutdownMonitor

pub fn is_shutdown(&self) -> bool

Returns true if the shutdown signal has been received, and false otherwise.

Examples

#[tokio::main]
async fn main() {
  let shutdown = shutdown_async::ShutdownController::new();
  let mut monitor = shutdown.subscribe();

  // Assert that the monitor has not yet received the shutdown signal
  assert!(!monitor.is_shutdown());
}

pub async fn recv(&mut self) -> impl Future<Output = ()>

Receive the shutdown notice, waiting if necessary.

Examples

async fn long_lived_task(mut monitor: shutdown_async::ShutdownMonitor) {
   // Wait for the shutdown signal
   monitor.recv().await;
}