Function esp_idf_sys::vTaskResume

source ·
pub unsafe extern "C" fn vTaskResume(xTaskToResume: TaskHandle_t)
Expand description

@cond !DOC_EXCLUDE_HEADER_SECTION task. h @code{c} void vTaskResume( TaskHandle_t xTaskToResume ); @endcode @endcond

INCLUDE_vTaskSuspend must be defined as 1 for this function to be available. See the configuration section for more information.

Resumes a suspended task.

A task that has been suspended by one or more calls to vTaskSuspend () will be made available for running again by a single call to vTaskResume ().

@param xTaskToResume Handle to the task being readied.

Example usage: @code{c} void vAFunction( void ) { TaskHandle_t xHandle;

// Create a task, storing the handle. xTaskCreate( vTaskCode, “NAME”, STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );

// …

// Use the handle to suspend the created task. vTaskSuspend( xHandle );

// …

// The created task will not run during this period, unless // another task calls vTaskResume( xHandle ).

//…

// Resume the suspended task ourselves. vTaskResume( xHandle );

// The created task will once again get microcontroller processing // time in accordance with its priority within the system. } @endcode @cond !DOC_SINGLE_GROUP \defgroup vTaskResume vTaskResume @endcond \ingroup TaskCtrl