mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-24 00:00:11 +02:00
Carl Lerche
4d514b7eb3
This patch relicenses the Tokio project exclusively under the MIT license. Before this, the project was dual licensed under MIT and Apache 2. As such, switching to only MIT is permitted. Fixes #202
43 lines
1.5 KiB
Markdown
43 lines
1.5 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 the [MIT license](../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.
|