#shutdown #async

shutdown-async

Asynchronous Shutdown

3 unstable releases

0.1.1 Mar 31, 2023
0.1.0 Mar 30, 2023
0.0.0 Mar 30, 2023

#2083 in Asynchronous

Download history 2279/week @ 2024-07-24 2159/week @ 2024-07-31 2766/week @ 2024-08-07 2466/week @ 2024-08-14 2078/week @ 2024-08-21 1498/week @ 2024-08-28 1682/week @ 2024-09-04 2725/week @ 2024-09-11 1674/week @ 2024-09-18 3080/week @ 2024-09-25 2071/week @ 2024-10-02 2041/week @ 2024-10-09 1667/week @ 2024-10-16 3554/week @ 2024-10-23 1770/week @ 2024-10-30 1484/week @ 2024-11-06

8,828 downloads per month
Used in tokio-utils

MIT license

13KB
124 lines

Shutdown Async

github crates.io docs.rs build status codecov

A library for gracefully shutting down asynchronous applications

This may be useful when you want to allow all in-flight processing to complete before shutting down in order to maintain a consistent state.

Usage

Add this to your Cargo.toml:

[dependencies]
shutdown-async = "0.1.1"

You can use the library like so:

use shutdown_async::ShutdownController;

#[tokio::main]
async fn main() {
  let shutdown = ShutdownController::new();
   
  tokio::task::spawn({
    let mut monitor = shutdown.subscribe();
    async move {
      // Wait for something to happen
      tokio::select! {
       _ = monitor.recv() => { println!("shutdown initiated"); }
       _ = tokio::time::sleep(ONE_YEAR) => { println!("one year has passed!"); }
      }
    }
  });

  shutdown.shutdown().await;
}

static ONE_YEAR: std::time::Duration = std::time::Duration::from_secs(60 * 60 * 24 * 365);

Dependencies

~2–7.5MB
~47K SLoC