mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-17 00:00:11 +02:00
Carl Lerche
4d514b7eb3
This patch relicenses the Tokio project exclusively under the MIT license. Before this, the project was dual licensed under MIT and Apache 2. As such, switching to only MIT is permitted. Fixes #202
48 lines
1.8 KiB
Markdown
48 lines
1.8 KiB
Markdown
# tokio-executor
|
|
|
|
Task execution related traits and utilities.
|
|
|
|
[Documentation](https://tokio-rs.github.io/tokio/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 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.
|