Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
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
ShadowConnectParametersDefaultto initialize this struct
d
Definition at line 71 of file aws_iot_shadow_interface.h.
Friends And Related Function Documentation
const ShadowConnectParameters_t ShadowConnectParametersDefault [related] |
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.
| char* pMqttClientId |
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.
Generated on Tue Jul 12 2022 19:02:39 by
1.7.2