A runtime for writing reliable, asynchronous, and slim applications with the Rust programming language.
Rust
jasonish and tobz Add tokio-tls echo example. (#541)
Based on the current example on the front page of tokio.rs.
Latest commit 767b370 Aug 15, 2018
Permalink
Failed to load latest commit information.
benches Deprecate executor re-exports (#412) Jun 12, 2018
ci Fix Weak tsan whitelist (#505) Jul 24, 2018
examples Reexport Encoder, Decoder, Framed* from tokio::codec (#499) Aug 14, 2018
src Reexport Encoder, Decoder, Framed* from tokio::codec (#499) Aug 14, 2018
tests Routine dependencies update (#533) Aug 10, 2018
tokio-codec Update `lines_encoder` test to use LinesCodec (#544) Aug 15, 2018
tokio-current-thread Remove dead futures2 code. (#538) Aug 10, 2018
tokio-executor Remove dead futures2 code. (#538) Aug 10, 2018
tokio-fs Routine dependencies update (#533) Aug 10, 2018
tokio-io Fix the doc of read_to_end method (#482) Jul 24, 2018
tokio-reactor Remove dead futures2 code. (#538) Aug 10, 2018
tokio-tcp Routine dependencies update (#533) Aug 10, 2018
tokio-threadpool Routine dependencies update (#533) Aug 10, 2018
tokio-timer Routine dependencies update (#533) Aug 10, 2018
tokio-tls Add tokio-tls echo example. (#541) Aug 15, 2018
tokio-udp Routine dependencies update (#533) Aug 10, 2018
tokio-uds Routine dependencies update (#533) Aug 10, 2018
.appveyor.yml Build both x86 and x64 on Windows (#282) Apr 2, 2018
.gitignore Rename to tokio-core, add in futures-io Aug 26, 2016
.travis.yml Enable sanitizer tests for tokio-threadpool (#537) Aug 10, 2018
CHANGELOG.md Bump version to v0.1.7 (#396) Jun 7, 2018
Cargo.toml Reexport Encoder, Decoder, Framed* from tokio::codec (#499) Aug 14, 2018
LICENSE Relicense Tokio exclusively under the MIT license. (#215) Mar 10, 2018
README.md General rustdoc improvements (#450) Jul 22, 2018

README.md

Tokio

A runtime for writing reliable, asynchronous, and slim applications with the Rust programming language. 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.

Crates.io MIT licensed Travis Build Status Appveyor Build Status Gitter chat

Website | Guides | API Docs | Chat

The API docs for the master branch are published here.

Overview

Tokio is an event-driven, non-blocking I/O platform for writing asynchronous applications with the Rust programming language. At a high level, it provides a few major components:

  • A multithreaded, work-stealing based task scheduler.
  • A reactor backed by the operating system's event queue (epoll, kqueue, IOCP, etc...).
  • Asynchronous TCP and UDP sockets.

These components provide the runtime components necessary for building an asynchronous application.

Example

A basic TCP echo server with Tokio:

extern crate tokio;

use tokio::prelude::*;
use tokio::io::copy;
use tokio::net::TcpListener;

fn main() {
    // Bind the server's socket.
    let addr = "127.0.0.1:12345".parse().unwrap();
    let listener = TcpListener::bind(&addr)
        .expect("unable to bind TCP listener");

    // Pull out a stream of sockets for incoming connections
    let server = listener.incoming()
        .map_err(|e| eprintln!("accept failed = {:?}", e))
        .for_each(|sock| {
            // Split up the reading and writing parts of the
            // socket.
            let (reader, writer) = sock.split();

            // A future that echos the data and returns how
            // many bytes were copied...
            let bytes_copied = copy(reader, writer);

            // ... after which we'll print what happened.
            let handle_conn = bytes_copied.map(|amt| {
                println!("wrote {:?} bytes", amt)
            }).map_err(|err| {
                eprintln!("IO error {:?}", err)
            });

            // Spawn the future as a concurrent task.
            tokio::spawn(handle_conn)
        });

    // Start the Tokio runtime
    tokio::run(server);
}

More examples can be found here.

Project layout

The tokio crate, found at the root, is primarily intended for use by application developers. Library authors should depend on the sub crates, which have greater guarantees of stability.

The crates included as part of Tokio are:

  • tokio-codec: Utilities for encoding and decoding protocol frames.

  • tokio-current-thread: Schedule the execution of futures on the current thread.

  • tokio-executor: Task execution related traits and utilities.

  • tokio-fs: Filesystem (and standard in / out) APIs.

  • tokio-io: Asynchronous I/O related traits and utilities.

  • tokio-reactor: Event loop that drives I/O resources (like TCP and UDP sockets).

  • tokio-tcp: TCP bindings for use with tokio-io and tokio-reactor.

  • tokio-threadpool: Schedules the execution of futures across a pool of threads.

  • tokio-timer: Time related APIs.

  • tokio-udp: UDP bindings for use with tokio-io and tokio-reactor.

  • tokio-uds: Unix Domain Socket bindings for use with tokio-io and tokio-reactor.

License

This project is licensed under the MIT 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.