MQTTConnectParams Struct Reference

MQTT Connection Parameters.

Defining a type for MQTT connection parameters. Passed into client when establishing a connection.

#include <aws_iot_mqtt_interface.h>

Data Fields
iot_disconnect_handler	disconnectHandler
	Callback to be invoked upon connection loss. More...
uint8_t	enableAutoReconnect
	Set to true to enable auto reconnect. More...
bool	isCleansession
	MQTT clean session. True = this session is to be treated as clean. Previous server state is cleared and no stated is retained from this connection. More...
bool	isSSLHostnameVerify
	Client should perform server certificate hostname validation. More...
bool	isWillMsgPresent
	Is there a LWT associated with this connection? More...
uint16_t	KeepAliveInterval_sec
	MQTT keep alive interval in seconds. Defines inactivity time allowed before determining the connection has been lost. More...
uint32_t	mqttCommandTimeout_ms
	Timeout for MQTT blocking calls. In milliseconds. More...
MQTT_Ver_t	MQTTVersion
	Desired MQTT version used during connection. More...
char *	pClientID
	Pointer to a string defining the MQTT client ID (this needs to be unique per device across your AWS account) More...
char *	pDeviceCertLocation
	Pointer to a string defining the device identity certificate file (full file, not path) More...
char *	pDevicePrivateKeyLocation
	Pointer to a string defining the device private key file (full file, not path) More...
char *	pHostURL
	Pointer to a string defining the endpoint for the MQTT service. More...
uint16_t	port
	MQTT service listening port. More...
char *	pPassword
	Not used in the AWS IoT Service. More...
char *	pRootCALocation
	Pointer to a string defining the Root CA file (full file, not path) More...
char *	pUserName
	Not used in the AWS IoT Service. More...
uint32_t	tlsHandshakeTimeout_ms
	TLS handshake timeout. In milliseconds. More...
MQTTwillOptions	will
	MQTT LWT parameters. More...

iot_disconnect_handler MQTTConnectParams::disconnectHandler

Callback to be invoked upon connection loss.

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

uint8_t MQTTConnectParams::enableAutoReconnect

Set to true to enable auto reconnect.

Referenced by aws_iot_mqtt_connect().

bool MQTTConnectParams::isCleansession

MQTT clean session. True = this session is to be treated as clean. Previous server state is cleared and no stated is retained from this connection.

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

bool MQTTConnectParams::isSSLHostnameVerify

Client should perform server certificate hostname validation.

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

bool MQTTConnectParams::isWillMsgPresent

Is there a LWT associated with this connection?

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

uint16_t MQTTConnectParams::KeepAliveInterval_sec

MQTT keep alive interval in seconds. Defines inactivity time allowed before determining the connection has been lost.

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

uint32_t MQTTConnectParams::mqttCommandTimeout_ms

Timeout for MQTT blocking calls. In milliseconds.

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

MQTT_Ver_t MQTTConnectParams::MQTTVersion

Desired MQTT version used during connection.

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

char* MQTTConnectParams::pClientID

Pointer to a string defining the MQTT client ID (this needs to be unique per device across your AWS account)

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

char* MQTTConnectParams::pDeviceCertLocation

Pointer to a string defining the device identity certificate file (full file, not path)

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

char* MQTTConnectParams::pDevicePrivateKeyLocation

Pointer to a string defining the device private key file (full file, not path)

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

char* MQTTConnectParams::pHostURL

Pointer to a string defining the endpoint for the MQTT service.

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

uint16_t MQTTConnectParams::port

MQTT service listening port.

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

char* MQTTConnectParams::pPassword

Not used in the AWS IoT Service.

Referenced by aws_iot_mqtt_connect(), and aws_iot_shadow_connect().

char* MQTTConnectParams::pRootCALocation

Pointer to a string defining the Root CA file (full file, not path)

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

char* MQTTConnectParams::pUserName

Not used in the AWS IoT Service.

Referenced by aws_iot_mqtt_connect(), and aws_iot_shadow_connect().

uint32_t MQTTConnectParams::tlsHandshakeTimeout_ms

TLS handshake timeout. In milliseconds.

Referenced by aws_iot_mqtt_connect(), aws_iot_shadow_connect(), and main().

MQTTwillOptions MQTTConnectParams::will

MQTT LWT parameters.

Referenced by aws_iot_mqtt_connect().