Task Pool API Reference
Task pool library
IotTaskPool_CreateSystemTaskPool

Creates the one single instance of the system task pool.

This function should be called once by the application to initialize the one single instance of the system task pool. An application should initialize the system task pool early in the boot sequence, before initializing any other library and before posting any jobs. Early initialization it typically easy to accomplish by creating the system task pool before starting the scheduler.

This function does not allocate memory to hold the task pool data structures and state, but it may allocate memory to hold the dependent entities and data structures, e.g. the threads of the task pool. The system task pool handle is recoverable for later use by calling IotTaskPool_GetSystemTaskPool or the shortcut IOT_SYSTEM_TASKPOOL.

Parameters
[in]pInfoA pointer to the task pool initialization data.
Returns
One of the following:
Warning
This function should be called only once. Calling this function more that once will result in undefined behavior.
IotTaskPoolInfo_t
Initialization information to create one task pool instance.
Definition: iot_taskpool_types.h:273
IotTaskPool_CreateSystemTaskPool
IotTaskPoolError_t IotTaskPool_CreateSystemTaskPool(const IotTaskPoolInfo_t *const pInfo)
Creates the one single instance of the system task pool.
Definition: iot_taskpool.c:255
IotTaskPoolError_t
IotTaskPoolError_t
Return codes of task pool functions.
Definition: iot_taskpool_types.h:50