Handles

Opaque handles of the task pool. More...

Typedefs
typedef struct _taskPool *	IotTaskPool_t
	Opaque handle of a Task Pool instance. More...
typedef struct _taskPoolJob *	IotTaskPoolJob_t
	Opaque handle of a Task Pool Job. More...

Detailed Description

Opaque handles of the task pool.

Typedef Documentation

IotTaskPool_t

typedef struct _taskPool* IotTaskPool_t

Opaque handle of a Task Pool instance.

This type identifies a Task Pool instance, which is valid after a successful call to IotTaskPool_CreateSystemTaskPool or IotTaskPool_Create. A variable of this type is passed as the first argument to Task Pool library functions to identify which task pool that function acts on.

A call to IotTaskPool_Destroy makes a task pool handle invalid. Once IotTaskPool_Destroy returns, the task handle should no longer be used.

All instances of IotTaskPool_t should be initialized with IOT_TASKPOOL_INITIALIZER.

IotTaskPoolJob_t

typedef struct _taskPoolJob* IotTaskPoolJob_t

Opaque handle of a Task Pool Job.

This type identifies a Task Pool Job instance, which is valid after a successful call to IotTaskPool_CreateJob or IotTaskPool_CreateRecyclableJob.

A call to IotTaskPool_RecycleJob or IotTaskPool_DestroyRecyclableJob makes a task pool job handle invalid. Once IotTaskPool_RecycleJob or IotTaskPool_DestroyRecyclableJob returns, the task job handle should no longer be used.

All instances of IotTaskPoolJob_t should be initialized with IOT_TASKPOOL_JOB_INITIALIZER.