mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-29 00:00:11 +02:00
Update the README (#164)
This commit is contained in:
@@ -1,6 +1,16 @@
|
|||||||
# Tokio
|
# Tokio
|
||||||
|
|
||||||
A platform for writing fast networking code with Rust.
|
A runtime for writing reliable, asynchronous, and slim applications with
|
||||||
|
the Rust programming langauge. It is:
|
||||||
|
|
||||||
|
* **Fast**: Tokio's zero-cost abstractions give you bare-metal
|
||||||
|
performance.
|
||||||
|
|
||||||
|
* **Reliable**: Tokio leverages Rust's ownership, type system, and
|
||||||
|
concurrency model to reduce bugs and ensure thread safety.
|
||||||
|
|
||||||
|
* **Scalable**: Tokio has a minimal footprint, and handles backpressure
|
||||||
|
and cancellation naturally.
|
||||||
|
|
||||||
[![Travis Build Status][travis-badge]][travis-url]
|
[![Travis Build Status][travis-badge]][travis-url]
|
||||||
[![Appveyor Build Status][appveyor-badge]][appveyor-url]
|
[![Appveyor Build Status][appveyor-badge]][appveyor-url]
|
||||||
@@ -16,14 +26,21 @@ A platform for writing fast networking code with Rust.
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Tokio is an event-driven, non-blocking I/O platform for writing asynchronous I/O
|
Tokio is an event-driven, non-blocking I/O platform for writing
|
||||||
backed applications. It is used for implementing networking clients and servers.
|
asynchronous applications with the Rust programming language. At a high
|
||||||
|
level, it provides a few major components:
|
||||||
|
|
||||||
Tokio uses the [`futures`] crate as a foundation to build on, providing
|
* A multi threaded, work-stealing based task [scheduler].
|
||||||
networking types and other utilities needed for building a production ready
|
* A [reactor] backed by the operating system's event queue (epoll, kqueue,
|
||||||
application.
|
IOCP, etc...).
|
||||||
|
* Asynchronous [TCP and UDP][net] sockets.
|
||||||
|
|
||||||
[`futures`]: https://github.com/rust-lang-nursery/futures-rs
|
These components provide the runtime components necessary for building
|
||||||
|
an asynchronous application.
|
||||||
|
|
||||||
|
[net]: https://docs.rs/tokio/0.1/tokio/net/index.html
|
||||||
|
[reactor]: https://docs.rs/tokio/0.1.1/tokio/reactor/index.html
|
||||||
|
[scheduler]: https://tokio-rs.github.io/tokio/tokio/runtime/index.html
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user