test

Embed: (wiki syntax)

« Back to documentation index

ShadowInitParameters_t Struct Reference

ShadowInitParameters_t Struct Reference

Shadow Initialization parameters. More...

#include <aws_iot_shadow_interface.h>

Data Fields

char * pHost
 This will be unique to a customer and can be retrieved from the console.
uint16_t port
 By default the port is 8883.
char * pRootCA
 Location with the Filename of the Root CA.
char * pClientCRT
 Location of Device certs signed by AWS IoT service.
char * pClientKey
 Location of Device private key.
bool enableAutoReconnect
 Set to true to enable auto reconnect.
iot_disconnect_handler disconnectHandler
 Callback to be invoked upon connection loss.

Related Functions

(Note that these are not member functions.)


const ShadowInitParameters_t ShadowInitParametersDefault
 This is set to defaults from the configuration file The certs are set to NULL because they need the path to the file. shadow_sample.c file demonstrates on how to get the relative path.

Detailed Description

Shadow Initialization parameters.

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

Note:
Always use the ShadowIniTParametersDefault to initialize this struct

Definition at line 52 of file aws_iot_shadow_interface.h.


Friends And Related Function Documentation

This is set to defaults from the configuration file The certs are set to NULL because they need the path to the file. shadow_sample.c file demonstrates on how to get the relative path.

Definition at line 84 of file aws_iot_shadow_interface.h.


Field Documentation

Callback to be invoked upon connection loss.

Definition at line 59 of file aws_iot_shadow_interface.h.

Set to true to enable auto reconnect.

Definition at line 58 of file aws_iot_shadow_interface.h.

char* pClientCRT

Location of Device certs signed by AWS IoT service.

Definition at line 56 of file aws_iot_shadow_interface.h.

char* pClientKey

Location of Device private key.

Definition at line 57 of file aws_iot_shadow_interface.h.

char* pHost

This will be unique to a customer and can be retrieved from the console.

Definition at line 53 of file aws_iot_shadow_interface.h.

uint16_t port

By default the port is 8883.

Definition at line 54 of file aws_iot_shadow_interface.h.

char* pRootCA

Location with the Filename of the Root CA.

Definition at line 55 of file aws_iot_shadow_interface.h.