aboutsummaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorLiigo Zhuang <[email protected]>2022-04-22 15:10:59 +0800
committerLiigo Zhuang <[email protected]>2022-04-22 15:10:59 +0800
commitb97592248a187023e16024541010de882f20dabc (patch)
tree84b20ff051d9b0407715d8af06ded343a4d0d838 /docs/modules
parenta61daa9f7ffb2560a5f2230203bb370ff4c6db50 (diff)
reword task finish and cancel
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/ROOT/pages/runtime.adoc2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/modules/ROOT/pages/runtime.adoc b/docs/modules/ROOT/pages/runtime.adoc
index 921a234c0..0adaa21a0 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
14 14
15== Executor 15== Executor
16 16
17The 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. 17The 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. When a task is finished or canceled, it will not be enqueued again.
18 18
19IMPORTANT: The executor relies on tasks not blocking indefinitely, as this prevents the executor to regain control and schedule another task. 19IMPORTANT: The executor relies on tasks not blocking indefinitely, as this prevents the executor to regain control and schedule another task.
20 20