Skip to content

Changes

Page history
Update Scheduling authored by Clément Foucher's avatar Clément Foucher
Hide whitespace changes
Inline Side-by-side
Modules/Scheduling.md
View page @ a7876355
......@@ -65,7 +65,7 @@ Check the return value of the function, if it is `-1`, there have been an error
If the return value is not `-1`, it represents the task ID. You can later call `scheduling.startUninterruptibleSynchronousTask()` with the task ID as a parameter to launch the task.
In the task main function (function passed as parameter to `defineAsynchronousTask()`), you can call `scheduling.suspendCurrentTaskMs()` or `scheduling.suspendCurrentTaskUs()` to suspend the task for a certain amount of time. This allows to reduce calls to this task when it is not mandatory for it to run permanently, as when no other task is running, asynchronous tasks are "permanently" running in background.
In the task main function (function passed as parameter to `defineAsynchronousTask()`), you can call `scheduling.suspendCurrentTaskMs()` or `scheduling.suspendCurrentTaskUs()` to suspend the task for a certain amount of time. This allows to reduce calls to this task when it is not mandatory for it to run permanently, as when no other task is running, asynchronous tasks are "permanently" running in background. This allows to reach a pseudo-periodic behavior. Note that the suspension time represents a minimum duration, and not an exact timing between the execution of the code before the suspension and after it. If you require precise timing, use synchronous tasks for this matter.
# Module enable and dependencies
......