[go: up one dir, main page]

Crate tokio_reactor

Source
Expand description

Event loop that drives Tokio I/O resources.

Note: This crate is deprecated in tokio 0.2.x and has been moved and refactored into various places in the tokio::runtime and tokio::io modules of the tokio crate. The Reactor has also been renamed the “I/O Driver”.

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.

For more details, see reactor module documentation in the Tokio crate.

Structs§

Background
Handle to the reactor running on a background thread.
DefaultGuard
Ensure that the default reactor is removed from the thread-local context when leaving the scope. This handles cases that involve panicking.
Handle
A reference to a reactor.
PollEvented
Associates an I/O resource that implements the std::io::Read and/or std::io::Write traits with the reactor that drives it.
Reactor
The core reactor, or event loop.
Registration
Associates an I/O resource with the reactor instance that drives it.
SetFallbackError
Error returned from Handle::set_fallback.
Shutdown
Future that resolves when the reactor thread has shutdown.
Turn
Return value from the turn method on Reactor.

Functions§

set_default
Sets handle as the default reactor, returning a guard that unsets it when dropped.
with_default
Set the default reactor for the duration of the closure