mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-09-07 00:00:08 +02:00
50 lines
1.7 KiB
Markdown
50 lines
1.7 KiB
Markdown
|
# tokio-reactor
|
||
|
|
|
||
|
|
Event loop that drives Tokio I/O resources.
|
||
|
|
|
||
|
|
[Documentation](https://tokio-rs.github.io/tokio/tokio_reactor/)
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
The reactor is the engine that drives asynchronous I/O resources (like TCP and
|
||
|
|
UDP sockets). It is backed by [`mio`] and acts as a bridge between [`mio`] and
|
||
|
|
[`futures`].
|
||
|
|
|
||
|
|
The crate provides:
|
||
|
|
|
||
|
|
* [`Reactor`] is the main type of this crate. It performs the event loop logic.
|
||
|
|
|
||
|
|
* [`Handle`] provides a reference to a reactor instance.
|
||
|
|
|
||
|
|
* [`Registration`] and [`PollEvented`] allow third parties to implement I/O
|
||
|
|
resources that are driven by the reactor.
|
||
|
|
|
||
|
|
Application authors will not use this crate directly. Instead, they will use the
|
||
|
|
[`tokio`] crate. Library authors should only depend on `tokio-reactor` if they
|
||
|
|
are building a custom I/O resource.
|
||
|
|
|
||
|
|
[`mio`]: http://github.com/carllerche/mio
|
||
|
|
[`futures`]: http://github.com/rust-lang-nursery/futures-rs
|
||
|
|
[`Reactor`]: https://tokio-rs.github.io/tokio/tokio_reactor/struct.Reactor.html
|
||
|
|
[`Handle`]: https://tokio-rs.github.io/tokio/tokio_reactor/struct.Handle.html
|
||
|
|
[`Registration`]: https://tokio-rs.github.io/tokio/tokio_reactor/struct.Registration.html
|
||
|
|
[`PollEvented`]: https://tokio-rs.github.io/tokio/tokio_reactor/struct.PollEvented.html
|
||
|
|
[`tokio`]: ../
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This project is licensed under either of
|
||
|
|
|
||
|
|
* Apache License, Version 2.0, ([LICENSE-APACHE](../LICENSE-APACHE) or
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0)
|
||
|
|
* MIT license ([LICENSE-MIT](../LICENSE-MIT) or
|
||
|
|
http://opensource.org/licenses/MIT)
|
||
|
|
|
||
|
|
at your option.
|
||
|
|
|
||
|
|
### Contribution
|
||
|
|
|
||
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
||
|
|
for inclusion in Tokio by you, as defined in the Apache-2.0 license, shall be
|
||
|
|
dual licensed as above, without any additional terms or conditions.
|