Functions

Functions of the task pool library.

The task pool library consists of the following functions.

• IotTaskPool_CreateSystemTaskPool
  Creates the one single instance of the system task pool.
• IotTaskPool_GetSystemTaskPool
  Retrieves the one and only instance of a system task pool.
• IotTaskPool_Create
  Creates one instance of a task pool.
• IotTaskPool_Destroy
  Destroys a task pool instance and collects all memory associated with a task pool and its satellite data structures.
• IotTaskPool_SetMaxThreads
  Sets the maximum number of threads for one instance of a task pool.
• IotTaskPool_CreateJob
  Creates a job for the task pool around a user-provided storage.
• IotTaskPool_CreateRecyclableJob
  Creates a job for the task pool by allocating the job dynamically.
• IotTaskPool_DestroyRecyclableJob
  This function un-initializes a job.
• IotTaskPool_RecycleJob
  Recycles a job into the task pool job cache.
• IotTaskPool_Schedule
  This function schedules a job created with IotTaskPool_CreateJob or IotTaskPool_CreateRecyclableJob against the task pool pointed to by taskPool.
• IotTaskPool_ScheduleDeferred
  This function schedules a job created with IotTaskPool_CreateJob against the task pool pointed to by taskPool to be executed after a user-defined time interval.
• IotTaskPool_GetStatus
  This function retrieves the current status of a job.
• IotTaskPool_TryCancel
  This function tries to cancel a job that was previously scheduled with IotTaskPool_Schedule.
• IotTaskPool_GetJobStorageFromHandle
  Returns a pointer to the job storage from an instance of a job handle of type IotTaskPoolJob_t. This function is guaranteed to succeed for a valid job handle.
• IotTaskPool_strerror
  Returns a string that describes an IotTaskPoolError_t.