AWS IoT Device SDK C: Task Pool
Task pool library
Return to main page ↑
Enumerated types

Enumerated types of the task pool. More...

Enumerations

enum  IotTaskPoolError_t {
  IOT_TASKPOOL_SUCCESS = 0, IOT_TASKPOOL_BAD_PARAMETER, IOT_TASKPOOL_ILLEGAL_OPERATION, IOT_TASKPOOL_NO_MEMORY,
  IOT_TASKPOOL_SHUTDOWN_IN_PROGRESS, IOT_TASKPOOL_CANCEL_FAILED, IOT_TASKPOOL_GENERAL_FAILURE
}
 Return codes of task pool functions. More...
 
enum  IotTaskPoolJobStatus_t {
  IOT_TASKPOOL_STATUS_READY = 0, IOT_TASKPOOL_STATUS_SCHEDULED, IOT_TASKPOOL_STATUS_DEFERRED, IOT_TASKPOOL_STATUS_COMPLETED,
  IOT_TASKPOOL_STATUS_CANCELED, IOT_TASKPOOL_STATUS_UNDEFINED
}
 Status codes of task pool Job. More...
 

Detailed Description

Enumerated types of the task pool.

Enumerated types of the Task pool library.

Enumeration Type Documentation

◆ IotTaskPoolError_t

Return codes of task pool functions.

Enumerator
IOT_TASKPOOL_SUCCESS 

Task pool operation completed successfully.

IOT_TASKPOOL_BAD_PARAMETER 

Task pool operation failed because at least one parameter is invalid.

IOT_TASKPOOL_ILLEGAL_OPERATION 

Task pool operation failed because it is illegal.

IOT_TASKPOOL_NO_MEMORY 

Task pool operation failed because allocating memory failed.

IOT_TASKPOOL_SHUTDOWN_IN_PROGRESS 

Task pool operation failed because of an invalid parameter.

IOT_TASKPOOL_CANCEL_FAILED 

Task pool cancellation failed.

IOT_TASKPOOL_GENERAL_FAILURE 

Task pool operation general failure.

◆ IotTaskPoolJobStatus_t

Status codes of task pool Job.

Enumerator
IOT_TASKPOOL_STATUS_READY 

Job is ready to be scheduled.

IOT_TASKPOOL_STATUS_SCHEDULED 

Job has been queued for execution.

IOT_TASKPOOL_STATUS_DEFERRED 

Job has been scheduled for deferred execution.

IOT_TASKPOOL_STATUS_COMPLETED 

Job is executing.

IOT_TASKPOOL_STATUS_CANCELED 

Job has been canceled before executing.

IOT_TASKPOOL_STATUS_UNDEFINED 

Job status is undefined.