diff options
| author | Liigo Zhuang <liigo@qq.com> | 2022-04-21 17:17:01 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-21 17:17:01 +0800 |
| commit | a61daa9f7ffb2560a5f2230203bb370ff4c6db50 (patch) | |
| tree | b328f1dc6fe4d3e179d445be91cdbeca4ff3703a /docs | |
| parent | de7dd59fa9553a1a6b75ff09238c9529277b95e7 (diff) | |
| download | embassy-a61daa9f7ffb2560a5f2230203bb370ff4c6db50.zip | |
remove description which not makes sense
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/modules/ROOT/pages/runtime.adoc | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/modules/ROOT/pages/runtime.adoc b/docs/modules/ROOT/pages/runtime.adoc index 8ce28b4e..921a234c 100644 --- a/docs/modules/ROOT/pages/runtime.adoc +++ b/docs/modules/ROOT/pages/runtime.adoc @@ -14,7 +14,7 @@ The Embassy runtime is an async/await executor designed for embedded usage along == Executor -The executor function is described below. The executor keeps a queue of tasks that it should poll. When a task is created, it is polled (1). The task will attempt to make progress until it reaches a point where it would be blocked. This may happen whenever a task is .await'ing an async function. When that happens, the task yields execution by (2) returning `Poll::Pending`. Once a task yields, the executor enqueues the task at the end of the run queue, and proceeds to (3) poll the next task in the queue. If a task returns `Poll::Ready` it essentially means that the task is finished and will not be enqueued again. +The executor function is described below. The executor keeps a queue of tasks that it should poll. When a task is created, it is polled (1). The task will attempt to make progress until it reaches a point where it would be blocked. This may happen whenever a task is .await'ing an async function. When that happens, the task yields execution by (2) returning `Poll::Pending`. Once a task yields, the executor enqueues the task at the end of the run queue, and proceeds to (3) poll the next task in the queue. IMPORTANT: The executor relies on tasks not blocking indefinitely, as this prevents the executor to regain control and schedule another task. |