mirror of https://github.com/tokio-rs/tokio.git synced 2026-08-15 00:00:15 +02:00

T

Alex Crichton b84ef90a98 Move Framed from tokio-proto to core

This commit extracts the concrete implementation of `FrameIo` in tokio-proto to
tokio-core under the name `EasyFramed`. This extraction is accompanied with a
new `EasyBuf` buffer type to work with when parsing types.

The purpose of this movement is to provide a clear and easy entry point at the
`FramedIo` layer for those who need it. Eventually these buffer types will get
replaced or moved to the `bytes` crate, but in the interest of an 0.1 release
and remaining backwards compatible with the tokio-core 0.1 release this is
adding a separate module.

2016-10-21 11:46:32 -07:00

examples

fix(examples): Fix typos in chat example

2016-10-14 23:03:46 +02:00

src

Move Framed from tokio-proto to core

2016-10-21 11:46:32 -07:00

tests

Move Framed from tokio-proto to core

2016-10-21 11:46:32 -07:00

.gitignore

Rename to tokio-core, add in futures-io

2016-08-26 14:39:47 -07:00

.travis.yml

Update travis token

2016-08-26 14:44:01 -07:00

appveyor.yml

Add appveyor config

2016-08-26 14:45:55 -07:00

Cargo.toml

Don't need regex from env_logger

2016-10-12 23:34:58 -07:00

LICENSE-APACHE

Add license files

2016-08-26 14:56:21 -07:00

LICENSE-MIT

Add license files

2016-08-26 14:56:21 -07:00

README.md

Update readme with crates.io dep

2016-09-09 18:15:15 -07:00

README.md

tokio-core

Core I/O and event loop abstraction for asynchronous I/O in Rust built on futures and mio.

Documentation

Usage

First, add this to your Cargo.toml:

[dependencies]
tokio-core = "0.1"

Next, add this to your crate:

extern crate tokio_core;

Examples

There are a few small examples showing off how to use this library:

echo.rs - a simple TCP echo server
socks5.rs - an implementation of a SOCKSv5 proxy server

What is tokio-core?

This crate is a connection futures, a zero-cost implementation of futures in Rust, and mio and a crate for zero-cost asynchronous I/O. The types and structures implemented in tokio-core implement Future and Stream traits as appropriate. For example connecting a TCP stream returns a Future resolving to a TCP stream, and a TCP listener implements a stream of TCP streams (accepted connections).

This crate also provides facilities such as:

TCP streams
TCP listeners
UDP sockets
Timeouts
Data owned and local to the event loop
An Executor implementation for a futures' Task

The intention of tokio-core is to provide a concrete implementation for crates built on top of asynchronous I/O. For example you can easily turn a TCP stream into a TLS/SSL stream with the tokio-tls crate or use the combinators to compose working with data on sockets.

Check out the documentation for more information, and more coming here soon!

License

tokio-core is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.