10 releases

new 0.2.8 Jun 8, 2024
0.2.7 Jun 1, 2024
0.2.6 Apr 20, 2024
0.2.5 Oct 29, 2023
0.1.0 Jun 10, 2019

#1334 in Asynchronous

Download history 129263/week @ 2024-02-21 137533/week @ 2024-02-28 143555/week @ 2024-03-06 142472/week @ 2024-03-13 154035/week @ 2024-03-20 152352/week @ 2024-03-27 149415/week @ 2024-04-03 160150/week @ 2024-04-10 172498/week @ 2024-04-17 171745/week @ 2024-04-24 152414/week @ 2024-05-01 166543/week @ 2024-05-08 175469/week @ 2024-05-15 167541/week @ 2024-05-22 182737/week @ 2024-05-29 138559/week @ 2024-06-05

696,068 downloads per month
Used in 1,654 crates (4 directly)

Apache-2.0 OR MIT

30KB
481 lines

async-signal

Build License Cargo Documentation

Asynchronous signal handling.

This crate provides the Signals type, which can be used to listen for POSIX signals asynchronously. It can be seen as an asynchronous version of signal_hook::iterator::Signals.

Implementation

On unix, this crate uses the signal_hook_registry crate to register a listener for each signal. That listener will then send a message through a Unix socket to the Signals type, which will receive it and notify the user. Asynchronous notification is done through the async-io crate.

Note that the internal pipe has a limited capacity. Once it has reached capacity, additional signals will be dropped.

On Windows, a different implementation that only supports SIGINT is used. This implementation uses a channel to notify the user.

Examples

use async_signal::{Signal, Signals};
use futures_lite::prelude::*;
use signal_hook::low_level;

// Register the signals we want to receive.
let mut signals = Signals::new(&[
    Signal::Term,
    Signal::Quit,
    Signal::Int,
])?;

// Wait for a signal to be received.
while let Some(signal) = signals.next().await {
    // Print the signal.
    eprintln!("Received signal {:?}", signal);

    // After printing it, do whatever the signal was supposed to do in the first place.
    low_level::emulate_default_handler(signal.unwrap() as i32).unwrap();
}

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~3–13MB
~155K SLoC