Task Pool API Reference
Task pool library
_taskPool_t Struct Reference

The task pool data structure keeps track of the internal state and the signals for the dispatcher threads. The task pool is a thread safe data structure. More...

#include <iot_taskpool_internal.h>

Data Fields

IotDeQueue_t dispatchQueue
 The queue for the jobs waiting to be executed.
 
IotListDouble_t timerEventsList
 The timeouts queue for all deferred jobs waiting to be executed.
 
_taskPoolCache_t jobsCache
 A cache to re-use jobs in order to limit memory allocations.
 
uint32_t activeThreads
 The number of threads in the task pool at any given time.
 
int32_t priority
 The priority for all task pool threads.
 
SemaphoreHandle_t dispatchSignal
 The synchronization object on which threads are waiting for incoming jobs.
 
StaticSemaphore_t dispatchSignalBuffer
 The semaphore buffer.
 
StaticSemaphore_t startStopSignalBuffer
 The semaphore buffer.
 
TimerHandle_t timer
 The timer for deferred jobs.
 
StaticTimer_t timerBuffer
 The timer buffer.
 
bool running
 A flag to track whether the task pool is operational or should shut down.
 

Detailed Description

The task pool data structure keeps track of the internal state and the signals for the dispatcher threads. The task pool is a thread safe data structure.

Warning
This is a system-level data type that should not be modified or used directly in any application.
This is a system-level data type that can and will change across different versions of the platform, with no regards for backward compatibility.

The documentation for this struct was generated from the following file: