mirror of
https://github.com/tokio-rs/tokio.git
synced 2025-09-25 12:00:35 +00:00
9df1140340
Today the Unix and Windows implementations have similar yet differing implementations of hooking into OS events and propagating them to any listening futures. Rather than re-implement the same behavior two different ways, we should factor out any commonality into a shared module and keep the Unix/Windows modules focused solely on OS integrations. Reusing the same implementation across OS versions also allows for more consistent behavior between platforms, which also makes squashing bugs much easier. This change introduces the `registry` module which handles creating and initializing a global map of signals/events and their registered listeners. Each OS specific module is expected to implement the OS hooks which delegate to invoking the registry module's methods for distributing the event notifications. # Use registry module for Windows implementation Note this still uses the same architecture as previously: a driver task is spawned by the first registered event, and that task is responsible for delivering any events to registered futures. (If that first event loop goes away, all events will deadlock). A solution to this issue will be explored at a later time.
tokio-signal
Unix signal handling for Tokio.
Usage
First, add this to your Cargo.toml:
[dependencies]
tokio-signal = "0.2.8"
Next you can use this in conjunction with the tokio and futures crates:
use futures::{Future, Stream};
fn main() {
// Create an infinite stream of "Ctrl+C" notifications. Each item received
// on this stream may represent multiple ctrl-c signals.
let ctrl_c = tokio_signal::ctrl_c().flatten_stream();
// Process each ctrl-c as it comes in
let prog = ctrl_c.for_each(|()| {
println!("ctrl-c received!");
Ok(())
});
tokio::run(prog.map_err(|err| panic!("{}", err)));
}
License
This project is licensed under the MIT license.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Tokio by you, shall be licensed as MIT, without any additional terms or conditions.