Changes to enabled on-line compiler

Embed: (wiki syntax)

« Back to documentation index

ShadowConnectParameters_t Struct Reference

ShadowConnectParameters_t Struct Reference

Shadow Connect parameters. More...

#include <aws_iot_shadow_interface.h>

Data Fields

char * pMyThingName
 Every device has a Thing Shadow and this is the placeholder for name.
char * pMqttClientId
 Currently the Shadow uses MQTT to connect and it is important to ensure we have unique client id.
uint16_t mqttClientIdLen
 Currently the Shadow uses MQTT to connect and it is important to ensure we have unique client id.
pApplicationHandler_t deleteActionHandler
 Callback to be invoked when Thing shadow for this device is deleted.

Related Functions

(Note that these are not member functions.)


const ShadowConnectParameters_t ShadowConnectParametersDefault
 This is set to defaults from the configuration file The length of the client id is initialized as 0. This is due to C language limitations of using constant literals only for creating const variables. The client id will be assigned using the value from aws_iot_config.h but the length needs to be assigned in code. shadow_sample.c file demonstrates this.

Detailed Description

Shadow Connect parameters.

As the Shadow SDK uses MQTT underneath, it could be connected and disconnected on events to save some battery.

Note:
Always use the ShadowConnectParametersDefault to initialize this struct

d

Definition at line 71 of file aws_iot_shadow_interface.h.


Friends And Related Function Documentation

This is set to defaults from the configuration file The length of the client id is initialized as 0. This is due to C language limitations of using constant literals only for creating const variables. The client id will be assigned using the value from aws_iot_config.h but the length needs to be assigned in code. shadow_sample.c file demonstrates this.

Definition at line 94 of file aws_iot_shadow_interface.h.


Field Documentation

Callback to be invoked when Thing shadow for this device is deleted.

Definition at line 75 of file aws_iot_shadow_interface.h.

uint16_t mqttClientIdLen

Currently the Shadow uses MQTT to connect and it is important to ensure we have unique client id.

Definition at line 74 of file aws_iot_shadow_interface.h.

Currently the Shadow uses MQTT to connect and it is important to ensure we have unique client id.

Definition at line 73 of file aws_iot_shadow_interface.h.

char* pMyThingName

Every device has a Thing Shadow and this is the placeholder for name.

Definition at line 72 of file aws_iot_shadow_interface.h.