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.

IotTaskPoolError_t IotTaskPool_ScheduleDeferred( IotTaskPool_t taskPool,
                                                 IotTaskPoolJob_t job,
                                                 uint32_t timeMs );

See Design for a description of the jobs lifetime and interaction with the threads used in the task pool library.

Parameters

[in]	taskPool	A handle to the task pool that must have been previously initialized with. a call to IotTaskPool_Create.
[in]	job	A job to schedule for execution. This must be first initialized with a call to IotTaskPool_CreateJob.
[in]	timeMs	The time in milliseconds to wait before scheduling the job.

Returns

One of the following:

• IOT_TASKPOOL_SUCCESS
• IOT_TASKPOOL_BAD_PARAMETER
• IOT_TASKPOOL_ILLEGAL_OPERATION
• IOT_TASKPOOL_SHUTDOWN_IN_PROGRESS

Note

This function will not allocate memory.

Warning

The taskPool used in this function should be the same used to create the job pointed to by job, or the results will be undefined.