summaryrefslogtreecommitdiffstats
path: root/third_party/rust/tokio-reactor/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/tokio-reactor/README.md')
-rw-r--r--third_party/rust/tokio-reactor/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/third_party/rust/tokio-reactor/README.md b/third_party/rust/tokio-reactor/README.md
new file mode 100644
index 0000000000..0227c14e84
--- /dev/null
+++ b/third_party/rust/tokio-reactor/README.md
@@ -0,0 +1,42 @@
+# 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.