IotTaskPool_CreateRecyclableJob

Creates a job for the task pool by allocating the job dynamically.

IotTaskPoolError_t IotTaskPool_CreateRecyclableJob( IotTaskPool_t taskPool,
                                                    IotTaskPoolRoutine_t userCallback,
                                                    void * pUserContext,
                                                    IotTaskPoolJob_t * const pJob );

A recyclable job does not need to be allocated twice, but it can rather be reused through subsequent calls to IotTaskPool_CreateRecyclableJob.

Parameters

[in]	taskPool	A handle to the task pool for which to create a recyclable job.
[in]	userCallback	A user-specified callback for the job.
[in]	pUserContext	A user-specified context for the callback.
[out]	pJob	A pointer to an instance of IotTaskPoolJob_t that will be initialized when this function returns successfully. This handle can be used to inspect the job status with IotTaskPool_GetStatus or cancel the job with IotTaskPool_TryCancel, etc....

Returns

One of the following:

• IOT_TASKPOOL_SUCCESS
• IOT_TASKPOOL_BAD_PARAMETER
• IOT_TASKPOOL_NO_MEMORY
• IOT_TASKPOOL_SHUTDOWN_IN_PROGRESS

Warning

A recyclable job should be recycled with a call to IotTaskPool_RecycleJob rather than destroyed.