test
IoT_Client_Connect_Params Struct Reference
MQTT Connection Parameters. More...
#include <aws_iot_mqtt_client.h>
Data Fields | |
char | struct_id [4] |
The eyecatcher for this structure. must be MQTC. | |
MQTT_Ver_t | MQTTVersion |
Desired MQTT version used during connection. | |
char * | pClientID |
Pointer to a string defining the MQTT client ID (this needs to be unique per device across your AWS account) | |
uint16_t | clientIDLen |
Client Id Length. 16 bit unsigned integer. | |
uint16_t | keepAliveIntervalInSec |
MQTT keep alive interval in seconds. Defines inactivity time allowed before determining the connection has been lost. | |
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. | |
bool | isWillMsgPresent |
Is there a LWT associated with this connection? | |
IoT_MQTT_Will_Options | will |
MQTT LWT parameters. | |
char * | pUsername |
Not used in the AWS IoT Service, will need to be cstring if used. | |
uint16_t | usernameLen |
Username Length. 16 bit unsigned integer. | |
char * | pPassword |
Not used in the AWS IoT Service, will need to be cstring if used. | |
uint16_t | passwordLen |
Password Length. 16 bit unsigned integer. |
Detailed Description
MQTT Connection Parameters.
Defining a type for MQTT connection parameters. Passed into client when establishing a connection.
Definition at line 131 of file aws_iot_mqtt_client.h.
Field Documentation
uint16_t clientIDLen |
Client Id Length. 16 bit unsigned integer.
Definition at line 135 of file aws_iot_mqtt_client.h.
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.
Definition at line 137 of file aws_iot_mqtt_client.h.
bool isWillMsgPresent |
Is there a LWT associated with this connection?
Definition at line 138 of file aws_iot_mqtt_client.h.
uint16_t keepAliveIntervalInSec |
MQTT keep alive interval in seconds. Defines inactivity time allowed before determining the connection has been lost.
Definition at line 136 of file aws_iot_mqtt_client.h.
Desired MQTT version used during connection.
Definition at line 133 of file aws_iot_mqtt_client.h.
uint16_t passwordLen |
Password Length. 16 bit unsigned integer.
Definition at line 143 of file aws_iot_mqtt_client.h.
char* pClientID |
Pointer to a string defining the MQTT client ID (this needs to be unique per device across your AWS account)
Definition at line 134 of file aws_iot_mqtt_client.h.
char* pPassword |
Not used in the AWS IoT Service, will need to be cstring if used.
Definition at line 142 of file aws_iot_mqtt_client.h.
char* pUsername |
Not used in the AWS IoT Service, will need to be cstring if used.
Definition at line 140 of file aws_iot_mqtt_client.h.
char struct_id[4] |
The eyecatcher for this structure. must be MQTC.
Definition at line 132 of file aws_iot_mqtt_client.h.
uint16_t usernameLen |
Username Length. 16 bit unsigned integer.
Definition at line 141 of file aws_iot_mqtt_client.h.
MQTT LWT parameters.
Definition at line 139 of file aws_iot_mqtt_client.h.
Generated on Tue Jul 12 2022 20:38:50 by 1.7.2