Files
tokio/README.md
T

55 lines
1.3 KiB
Markdown

# tokio-signal
An implementation of Unix signal handling for Tokio
[![Build Status](https://travis-ci.org/alexcrichton/tokio-signal.svg?branch=master)](https://travis-ci.org/alexcrichton/tokio-signal)
[Documentation](https://docs.rs/tokio-signal)
## Usage
First, add this to your `Cargo.toml`:
```toml
[dependencies]
tokio-signal = "0.1"
```
Next you an use this in conjunction with the `tokio-core` and `futures` crates:
```rust,no_run
extern crate futures;
extern crate tokio_core;
extern crate tokio_signal;
use tokio_core::reactor::Core;
use futures::{Future, Stream};
fn main() {
let mut core = Core::new().unwrap();
let handle = core.handle();
// 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(&handle).flatten_stream();
// Process each ctrl-c as it comes in
let prog = ctrl_c.for_each(|()| {
println!("ctrl-c received!");
Ok(())
});
core.run(prog).unwrap();
}
```
# License
`tokio-signal` is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0), with portions covered by various
BSD-like licenses.
See LICENSE-APACHE, and LICENSE-MIT for details.