Function esp_idf_sys::vTaskEndScheduler

pub unsafe extern "C" fn vTaskEndScheduler()

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

NOTE: At the time of writing only the x86 real mode port, which runs on a PC in place of DOS, implements this function.

Stops the real time kernel tick. All created tasks will be automatically deleted and multitasking (either preemptive or cooperative) will stop. Execution then resumes from the point where vTaskStartScheduler () was called, as if vTaskStartScheduler () had just returned.

See the demo application file main. c in the demo/PC directory for an example that uses vTaskEndScheduler ().

vTaskEndScheduler () requires an exit function to be defined within the portable layer (see vPortEndScheduler () in port. c for the PC port). This performs hardware specific operations such as stopping the kernel tick.

vTaskEndScheduler () will cause all of the resources allocated by the kernel to be freed - but will not free resources allocated by application tasks.

Example usage: @code{c} void vTaskCode( void * pvParameters ) { for( ;; ) { // Task code goes here.

  // At some point we want to end the real time kernel processing
  // so call ...
  vTaskEndScheduler ();

} }

void vAFunction( void ) { // Create at least one task before starting the kernel. xTaskCreate( vTaskCode, “NAME”, STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );

// Start the real time kernel with preemption. vTaskStartScheduler ();

// Will only get here when the vTaskCode () task has called // vTaskEndScheduler (). When we get here we are back to single task // execution. } @endcode

@cond !DOC_SINGLE_GROUP \defgroup vTaskEndScheduler vTaskEndScheduler @endcond \ingroup SchedulerControl