Parameters for a Shadow API operation. More...

#include <aws_shadow.h>

Data Fields
const char *	pcThingName
	Thing name of Shadow.

const char *	pcData
	Input parameter for SHADOW_Update; output parameter of SHADOW_Get. More...

uint32_t	ulDataLength
	Input parameter for SHADOW_Update; output parameter of SHADOW_Get. More...

MQTTBufferHandle_t	xBuffer
	Output parameter of SHADOW_Get. More...

uint8_t	ucKeepSubscriptions
	Controls whether topic subscriptions remain active after a Shadow operation completes. More...

MQTTQoS_t	xQoS
	MQTT QoS when publishing from the Shadow Client to the Shadow Service. More...

Detailed Description

Parameters for a Shadow API operation.

Pass this struct as one of the arguments for SHADOW_Update, SHADOW_Get, or SHADOW_Delete.

Definition at line 144 of file aws_shadow.h.

Field Documentation

◆ pcData

const char* pcData

Input parameter for SHADOW_Update; output parameter of SHADOW_Get.

For SHADOW_Update, set this to point to the Shadow update document.
For SHADOW_Get, this is the output parameter pointing to a buffer which holds the Shadow document. If SHADOW_Get fails, this will be set to NULL.
This member is ignored by SHADOW_Delete.

Definition at line 155 of file aws_shadow.h.

◆ ucKeepSubscriptions

uint8_t ucKeepSubscriptions

Controls whether topic subscriptions remain active after a Shadow operation completes.

Allows the MQTT subscriptions of the operation to remain active if set to 1, saving time if the same operation is performed again. Set this value to 0 to deactivate the operation's MQTT subscriptions after the operation completes.

Warning: Users may be billed for extraneous messages received on an operation's MQTT topics. If other clients are publishing to the same topics, it is best to deactivate the subscriptions.

Definition at line 189 of file aws_shadow.h.

◆ ulDataLength

uint32_t ulDataLength

Input parameter for SHADOW_Update; output parameter of SHADOW_Get.

For SHADOW_Update, set this to length of the Shadow update document.
For SHADOW_Get, this is the output parameter specifying the length of ShadowOperationParams_t.pcData. If SHADOW_Get fails, this will be set to 0.
Note
If the received Shadow document is longer than this value, the document will be truncated. A warning message will be printed if #shadowENABLE_DEBUG_LOGS is 1.
This member is ignored by SHADOW_Delete.

Definition at line 167 of file aws_shadow.h.

◆ xBuffer

MQTTBufferHandle_t xBuffer

Output parameter of SHADOW_Get.

This member is ignored by SHADOW_Update.
For SHADOW_Get, this is the output parameter for the MQTT Buffer Handle. This buffer must be returned to the MQTT Client after the user is done with the received document by calling SHADOW_ReturnMQTTBuffer.
This member is ignored by SHADOW_Delete.

Definition at line 176 of file aws_shadow.h.

◆ xQoS

MQTTQoS_t xQoS

MQTT QoS when publishing from the Shadow Client to the Shadow Service.

Note: The Shadow services always publishes to the Shadow Client with QoS 1.

Definition at line 194 of file aws_shadow.h.

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

C:/AFR/freertos-master/lib/include/aws_shadow.h