mirror of https://github.com/tokio-rs/tokio.git synced 2025-09-25 12:00:35 +00:00

Go to file

Alex Crichton 293d104177 Remove Future::schedule

A more appealing model is actually just automatically inferring what needs to be
scheduled based on what actions are done during poll. For example if during a
poll you check a oneshot channel, then the current task is registered for being
woken up if it's not ready. Similarly this will apply to I/O where if I/O is
attempted but we see EAGAIN then we'll schedule the task to get notified when
it's ready.

This may also have performance benefits in some niche situations because you
don't need to recompute where you are in the state machine both during poll and
during schedule. Instead, it now happens all at once.

2016-08-17 18:41:34 -07:00

src

Remove Future::schedule

2016-08-17 18:41:34 -07:00

tests

Remove Future::schedule

2016-08-17 18:41:34 -07:00

Cargo.toml

Implement UDS bindings

2016-08-15 10:31:23 -07:00

README.md

Fix link in mio README

2016-08-08 23:20:05 -07:00

README.md

futures-mio

Bindings to the mio crate implementing the futures-io and futures abstractions.

Documentation

Usage

First, add this to your Cargo.toml:

[dependencies]
futures-mio = { git = "https://github.com/alexcrichton/futures-rs" }

Next, add this to your crate:

extern crate futures_mio;

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 futures-mio?

This crate is a connection futures, a zero-cost implementation of futures in Rust, and mio, a crate for zero-cost asynchronous I/O, and futures-io, abstractions for I/O on top of the futures crate. The types and structures implemented in futures-mio 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 futures-mio is to provide a concrete implementation for crates built on top of futures-io. For example you can easily turn a TCP stream into a TLS/SSL stream with the futures-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

futures-mio 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.