mirror of
https://github.com/tokio-rs/tokio.git
synced 2025-09-28 12:10:37 +00:00
961aae41c4
Also bumps: * tokio-async-await (0.1.5) * tokio-executor (0.1.6) * tokio-fs (0.1.5) * tokio-io (0.1.11) * tokio-reactor (0.1.8) * tokio-tcp (0.1.3) * tokio-threadpool (0.1.10) * tokio-tls (0.2.1) * tokio-uds (0.2.5) ...and updates LICENSE files to 2019.
48 lines
1.8 KiB
Markdown
48 lines
1.8 KiB
Markdown
# tokio-executor
|
|
|
|
Task execution related traits and utilities.
|
|
|
|
[Documentation](https://docs.rs/tokio-executor/0.1.6/tokio_executor)
|
|
|
|
## Overview
|
|
|
|
In the Tokio execution model, futures are lazy. When a future is created, no
|
|
work is performed. In order for the work defined by the future to happen, the
|
|
future must be submitted to an executor. A future that is submitted to an
|
|
executor is called a "task".
|
|
|
|
The executor is responsible for ensuring that [`Future::poll`] is called
|
|
whenever the task is [notified]. Notification happens when the internal state of
|
|
a task transitions from "not ready" to ready. For example, a socket might have
|
|
received data and a call to `read` will now be able to succeed.
|
|
|
|
This crate provides traits and utilities that are necessary for building an
|
|
executor, including:
|
|
|
|
* The [`Executor`] trait describes the API for spawning a future onto an
|
|
executor.
|
|
|
|
* [`enter`] marks that the current thread is entering an execution
|
|
context. This prevents a second executor from accidentally starting from
|
|
within the context of one that is already running.
|
|
|
|
* [`DefaultExecutor`] spawns tasks onto the default executor for the current
|
|
context.
|
|
|
|
* [`Park`] abstracts over blocking and unblocking the current thread.
|
|
|
|
[`Executor`]: https://tokio-rs.github.io/tokio/tokio_executor/trait.Executor.html
|
|
[`enter`]: https://tokio-rs.github.io/tokio/tokio_executor/fn.enter.html
|
|
[`DefaultExecutor`]: https://tokio-rs.github.io/tokio/tokio_executor/struct.DefaultExecutor.html
|
|
[`Park`]: https://tokio-rs.github.io/tokio/tokio_executor/park/index.html
|
|
|
|
## License
|
|
|
|
This project is licensed under the [MIT license](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.
|