Task Pool API Reference
Task pool library
IotTaskPoolInfo_t Struct Reference

Initialization information to create one task pool instance. More...

#include <iot_taskpool_types.h>

Data Fields

uint32_t minThreads
 Specifies the operating parameters for a task pool. More...
 
uint32_t maxThreads
 Maximum number of threads in a task pool. A task pool may try and grow the number of active threads up to IotTaskPoolInfo_t.maxThreads.
 
uint32_t stackSize
 Stack size for every task pool thread. The stack size for each thread is fixed after the task pool is created and cannot be changed.
 
int32_t priority
 priority for every task pool thread. The priority for each thread is fixed after the task pool is created and cannot be changed.
 

Detailed Description

Initialization information to create one task pool instance.

Parameter for: IotTaskPool_CreateSystemTaskPool IotTaskPool_Create.

Passed as an argument to IotTaskPool_Create.

All instances of IotTaskPoolInfo_t should be initialized with IOT_TASKPOOL_INFO_INITIALIZER.

Field Documentation

◆ minThreads

uint32_t IotTaskPoolInfo_t::minThreads

Specifies the operating parameters for a task pool.

Attention
IotTaskPoolInfo_t.minThreads MUST be at least 1. IotTaskPoolInfo_t.maxThreads MUST be greater or equal to IotTaskPoolInfo_t.minThreads. If the minimum number of threads is same as the maximum, then the task pool will not try and grow the number of worker threads at run time.

Minimum number of threads in a task pool. These threads will be created when the task pool is first created with IotTaskPool_Create.


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