Skip to content

Commit 536914b

Browse files
authored
Add catch up behavior to xTaskDelayUntil. (#1348)
Adds an explanation for why xTaskDelayUntil can break from the configured frequency when catching up for past events. More will be added to the website documentation.
1 parent 7d6890e commit 536914b

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

include/task.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -897,7 +897,8 @@ void vTaskDelay( const TickType_t xTicksToDelay ) PRIVILEGED_FUNCTION;
897897
*
898898
* @return Value which can be used to check whether the task was actually delayed.
899899
* Will be pdTRUE if the task way delayed and pdFALSE otherwise. A task will not
900-
* be delayed if the next expected wake time is in the past.
900+
* be delayed if the next expected wake time is in the past. This prevents periodic
901+
* tasks from accumulating delays and allows them to resume their regular timing pattern.
901902
*
902903
* Example usage:
903904
* @code{c}

0 commit comments

Comments
 (0)