Handles

Opaque handles of the Shadow library. More...

Typedefs
typedef struct _shadowOperation *	AwsIotShadowOperation_t
	Opaque handle that references an in-progress Shadow operation. More...

Detailed Description

Opaque handles of the Shadow library.

Typedef Documentation

AwsIotShadowOperation_t

typedef struct _shadowOperation* AwsIotShadowOperation_t

Opaque handle that references an in-progress Shadow operation.

Set as an output parameter of AwsIotShadow_DeleteAsync, AwsIotShadow_GetAsync, and AwsIotShadow_UpdateAsync. These functions send a message to the Shadow service requesting a Shadow operation; the result of this operation is unknown until the Shadow service sends a response. Therefore, this handle serves as a reference to Shadow operations awaiting a response from the Shadow service.

This reference will be valid from the successful return of AwsIotShadow_DeleteAsync, AwsIotShadow_GetAsync, or AwsIotShadow_UpdateAsync. The reference becomes invalid once the completion callback is invoked, or AwsIotShadow_Wait returns.

All instances of AwsIotShadowOperation_t should be initialized with AWS_IOT_SHADOW_OPERATION_INITIALIZER.

See also

AwsIotShadow_Wait and AWS_IOT_SHADOW_FLAG_WAITABLE for waiting on a reference; or AwsIotShadowCallbackInfo_t and AwsIotShadowCallbackParam_t for an asynchronous notification of completion.