Constants

Defined constants of the Jobs library.

Libraries may #define constants in their headers with special meanings. This page describes the meanings and uses of any constants defined by the Jobs library. Related constants are shown in a single section on this page.

Jobs Initializers

Provides default values for the data types of the Jobs library.

#define AWS_IOT_JOBS_CALLBACK_INFO_INITIALIZER    { 0 } 
#define AWS_IOT_JOBS_REQUEST_INFO_INITIALIZER \
    { .pClientToken = AWS_IOT_JOBS_CLIENT_TOKEN_AUTOGENERATE }

#define AWS_IOT_JOBS_UPDATE_INFO_INITIALIZER               \
    { .newStatus = AWS_IOT_JOB_STATE_IN_PROGRESS,          \
      .expectedVersion = AWS_IOT_JOBS_NO_VERSION,          \
      .executionNumber = AWS_IOT_JOBS_NO_EXECUTION_NUMBER, \
      .stepTimeoutInMinutes = AWS_IOT_JOBS_NO_TIMEOUT,     \
      .includeJobExecutionState = false,                   \
      .includeJobDocument = false,                         \
      .pStatusDetails = AWS_IOT_JOBS_NO_STATUS_DETAILS }
#define AWS_IOT_JOBS_OPERATION_INITIALIZER    NULL  
#define AWS_IOT_JOBS_RESPONSE_INITIALIZER     { 0 } 

All user-facing data types of the Jobs library should be initialized using one of the following.

Warning

Failing to initialize a Jobs data type with the appropriate initializer may result in undefined behavior!

Note

The initializers may change at any time in future versions, but their names will remain the same.

Example

AwsIotJobsCallbackInfo_t callbackInfo = AWS_IOT_JOBS_CALLBACK_INFO_INITIALIZER;
AwsIotJobsRequestInfo_t requestInfo = AWS_IOT_JOBS_REQUEST_INFO_INITIALIZER;
AwsIotJobsUpdateInfo_t updateInfo = AWS_IOT_JOBS_UPDATE_INFO_INITIALIZER;
AwsIotJobsOperation_t operation = AWS_IOT_JOBS_OPERATION_INITIALIZER;
AwsIotJobsResponse_t response = AWS_IOT_JOBS_RESPONSE_INITIALIZER;

Jobs Function Flags

Flags that modify the behavior of Jobs library functions.

Flags should be bitwise-ORed with each other to change the behavior of Jobs library functions.

The following flags are valid for the Jobs operation functions: AwsIotJobs_GetPendingAsync, AwsIotJobs_StartNextAsync, AwsIotJobs_DescribeAsync, AwsIotJobs_UpdateAsync, and their blocking versions.

• AWS_IOT_JOBS_FLAG_WAITABLE
  Allows the use of AwsIotJobs_Wait for blocking until completion.
• AWS_IOT_JOBS_FLAG_KEEP_SUBSCRIPTIONS
  Maintain the subscriptions for the Jobs operation topics, even after this function returns.

The following flags are valid for AwsIotJobs_RemovePersistentSubscriptions. These flags are not valid for the Jobs operation functions.

• AWS_IOT_JOBS_FLAG_REMOVE_GET_PENDING_SUBSCRIPTIONS
  Remove the persistent subscriptions from a Jobs get pending operation.
• AWS_IOT_JOBS_FLAG_REMOVE_START_NEXT_SUBSCRIPTIONS
  Remove the persistent subscriptions from a Jobs start next operation.
• AWS_IOT_JOBS_FLAG_REMOVE_DESCRIBE_SUBSCRIPTIONS
  Remove the persistent subscriptions from a Jobs describe operation.
• AWS_IOT_JOBS_FLAG_REMOVE_UPDATE_SUBSCRIPTIONS
  Remove the persistent subscriptions from a Jobs update operation.

Note

The values of the flags may change at any time in future versions, but their names will remain the same. Additionally, flags which may be used at the same time will be bitwise-exclusive of each other.