_shadowOperation_t Struct Reference

Internal structure representing a single Shadow operation (DELETE, GET, or UPDATE). More...

#include <aws_iot_shadow_internal.h>

Data Fields
IotLink_t	link
	List link member.
_shadowOperationType_t	type
	Operation type.
uint32_t	flags
	Flags passed to operation API function.
AwsIotShadowError_t	status
	Status of operation.
IotMqttConnection_t	mqttConnection
	MQTT connection associated with this operation.
_shadowSubscription_t *	pSubscription
	Shadow subscriptions object associated with this operation.
union {
struct {
void *(*   mallocDocument )(size_t)
	Function to allocate memory for an incoming Shadow document. More...
const char *   pDocument
	Retrieved Shadow document.
size_t   documentLength
	Length of retrieved Shadow document.
}   get
struct {
const char *   pClientToken
	Client token in update document.
size_t   clientTokenLength
	Length of client token.
}   update
}	u
	Valid member depends on _shadowOperation_t.type.
union {
IotSemaphore_t   waitSemaphore
	Semaphore to be used with AwsIotShadow_Wait.
AwsIotShadowCallbackInfo_t   callback
	User-provided callback function and parameter.
}	notify
	How to notify of an operation's completion.

Detailed Description

Internal structure representing a single Shadow operation (DELETE, GET, or UPDATE).

A list of these structures keeps track of all in-progress Shadow operations.

Field Documentation

mallocDocument

void*( * _shadowOperation_t::mallocDocument) (size_t)

Function to allocate memory for an incoming Shadow document.

Only used when the flag AWS_IOT_SHADOW_FLAG_WAITABLE is set.

---

The documentation for this struct was generated from the following file:

• aws_iot_shadow_internal.h