Handles

Opaque handles of the Jobs library. More...

Typedefs
typedef struct _jobsOperation *	AwsIotJobsOperation_t
	Opaque handle that references an in-progress Jobs operation. More...

Detailed Description

Opaque handles of the Jobs library.

Typedef Documentation

AwsIotJobsOperation_t

typedef struct _jobsOperation* AwsIotJobsOperation_t

Opaque handle that references an in-progress Jobs operation.

Set as an output parameter of AwsIotJobs_GetPendingAsync, AwsIotJobs_StartNextAsync, AwsIotJobs_DescribeAsync, and AwsIotJobs_UpdateAsync. These functions send a message to the Jobs service requesting a Jobs operation; the result of this operation is unknown until the Jobs service sends a response. Therefore, this handle serves as a reference to Jobs operations awaiting a response from the Jobs service.

This reference will be valid from the successful return of AwsIotJobs_GetPendingAsync, AwsIotJobs_StartNextAsync, AwsIotJobs_DescribeAsync, and AwsIotJobs_UpdateAsync. The reference becomes invalid once the completion callback is invoked, or AwsIotJobs_Wait returns.

All instances of AwsIotJobsOperation_t should be initialized with AWS_IOT_JOBS_OPERATION_INITIALIZER.

See also

AwsIotJobs_Wait and AWS_IOT_JOBS_FLAG_WAITABLE for waiting on a reference; or AwsIotJobsCallbackInfo_t and AwsIotJobsCallbackParam_t for an asynchronous notification of completion.