AwsIotShadow_GetSync

Retrieve a Thing Shadow with a timeout.

AwsIotShadowError_t AwsIotShadow_GetSync( IotMqttConnection_t mqttConnection,
                                          const AwsIotShadowDocumentInfo_t * pGetInfo,
                                          uint32_t flags,
                                          uint32_t timeoutMs,
                                          const char ** const pShadowDocument,
                                          size_t * const pShadowDocumentLength );

This function queues a Shadow get, then waits for the result. Internally, this function is a call to AwsIotShadow_GetAsync followed by AwsIotShadow_Wait. See AwsIotShadow_GetAsync for more information on the Shadow get operation.

Parameters

[in]	mqttConnection	The MQTT connection to use for Shadow get.
[in]	pGetInfo	Shadow document parameters.
[in]	flags	Flags which modify the behavior of this function. See Shadow Function Flags.
[in]	timeoutMs	If the Shadow service does not respond to the Shadow get within this timeout, this function returns AWS_IOT_SHADOW_TIMEOUT.
[out]	pShadowDocument	A pointer to a buffer containing the Shadow document retrieved by a Shadow get is placed here. The buffer was allocated with the function pGetInfo->get.mallocDocument. This output parameter is only valid if this function returns AWS_IOT_SHADOW_SUCCESS.
[out]	pShadowDocumentLength	The length of the Shadow document in pShadowDocument is placed here. This output parameter is only valid if this function returns AWS_IOT_SHADOW_SUCCESS.

Returns

One of the following:

• AWS_IOT_SHADOW_SUCCESS
• AWS_IOT_SHADOW_NOT_INITIALIZED
• AWS_IOT_SHADOW_BAD_PARAMETER
• AWS_IOT_SHADOW_NO_MEMORY
• AWS_IOT_SHADOW_MQTT_ERROR
• AWS_IOT_SHADOW_BAD_RESPONSE
• AWS_IOT_SHADOW_TIMEOUT
• A Shadow service rejection reason between 400 (AWS_IOT_SHADOW_BAD_REQUEST) and 500 (AWS_IOT_SHADOW_SERVER_ERROR)