Function esp_idf_sys::xTaskCatchUpTicks

pub unsafe extern "C" fn xTaskCatchUpTicks(
    xTicksToCatchUp: TickType_t,
) -> BaseType_t

@cond !DOC_EXCLUDE_HEADER_SECTION task.h @code{c} BaseType_t xTaskCatchUpTicks( TickType_t xTicksToCatchUp ); @endcode @endcond

This function corrects the tick count value after the application code has held interrupts disabled for an extended period resulting in tick interrupts having been missed.

This function is similar to vTaskStepTick(), however, unlike vTaskStepTick(), xTaskCatchUpTicks() may move the tick count forward past a time at which a task should be removed from the blocked state. That means tasks may have to be removed from the blocked state as the tick count is moved.

@param xTicksToCatchUp The number of tick interrupts that have been missed due to interrupts being disabled. Its value is not computed automatically, so must be computed by the application writer.

@return pdTRUE if moving the tick count forward resulted in a task leaving the blocked state and a context switch being performed. Otherwise pdFALSE.

\defgroup xTaskCatchUpTicks xTaskCatchUpTicks @cond !DOC_SINGLE_GROUP \ingroup TaskCtrl @endcond