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.
Dependencies: SDFileSystem
Fork of
ATT_AWS_IoT_demo
by 
Anthony Phillips
MQTTConnectParams Struct Reference
MQTT Connection Parameters. More...
#include <aws_iot_mqtt_interface.h>
Data Fields | |
| uint8_t | enableAutoReconnect |
| Set to true to enable auto reconnect. | |
| char * | pHostURL |
| Pointer to a string defining the endpoint for the MQTT service. | |
| uint16_t | port |
| MQTT service listening port. | |
| char * | pRootCALocation |
| Pointer to a string defining the Root CA file (full file, not path) | |
| char * | pDeviceCertLocation |
| Pointer to a string defining the device identity certificate file (full file, not path) | |
| char * | pDevicePrivateKeyLocation |
| Pointer to a string defining the device private key file (full file, not path) | |
| char * | pClientID |
| Pointer to a string defining the MQTT client ID (this needs to be unique per device across your AWS account) | |
| char * | pUserName |
| Not used in the AWS IoT Service. | |
| char * | pPassword |
| Not used in the AWS IoT Service. | |
| MQTT_Ver_t | MQTTVersion |
| Desired MQTT version used during connection. | |
| uint16_t | KeepAliveInterval_sec |
| 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? | |
| MQTTwillOptions | will |
| MQTT LWT parameters. | |
| uint32_t | mqttCommandTimeout_ms |
| Timeout for MQTT blocking calls. In milliseconds. | |
| uint32_t | tlsHandshakeTimeout_ms |
| TLS handshake timeout. In milliseconds. | |
| bool | isSSLHostnameVerify |
| Client should perform server certificate hostname validation. | |
| iot_disconnect_handler | disconnectHandler |
| Callback to be invoked upon connection loss. | |
Detailed Description
MQTT Connection Parameters.
Defining a type for MQTT connection parameters. Passed into client when establishing a connection.
Definition at line 82 of file aws_iot_mqtt_interface.h.
Field Documentation
Callback to be invoked upon connection loss.
Definition at line 100 of file aws_iot_mqtt_interface.h.
| uint8_t enableAutoReconnect |
Set to true to enable auto reconnect.
Definition at line 83 of file aws_iot_mqtt_interface.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 94 of file aws_iot_mqtt_interface.h.
| bool isSSLHostnameVerify |
Client should perform server certificate hostname validation.
Definition at line 99 of file aws_iot_mqtt_interface.h.
| bool isWillMsgPresent |
Is there a LWT associated with this connection?
Definition at line 95 of file aws_iot_mqtt_interface.h.
| uint16_t KeepAliveInterval_sec |
MQTT keep alive interval in seconds. Defines inactivity time allowed before determining the connection has been lost.
Definition at line 93 of file aws_iot_mqtt_interface.h.
| uint32_t mqttCommandTimeout_ms |
Timeout for MQTT blocking calls. In milliseconds.
Definition at line 97 of file aws_iot_mqtt_interface.h.
Desired MQTT version used during connection.
Definition at line 92 of file aws_iot_mqtt_interface.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 89 of file aws_iot_mqtt_interface.h.
| char* pDeviceCertLocation |
Pointer to a string defining the device identity certificate file (full file, not path)
Definition at line 87 of file aws_iot_mqtt_interface.h.
Pointer to a string defining the device private key file (full file, not path)
Definition at line 88 of file aws_iot_mqtt_interface.h.
| char* pHostURL |
Pointer to a string defining the endpoint for the MQTT service.
Definition at line 84 of file aws_iot_mqtt_interface.h.
| uint16_t port |
MQTT service listening port.
Definition at line 85 of file aws_iot_mqtt_interface.h.
| char* pPassword |
Not used in the AWS IoT Service.
Definition at line 91 of file aws_iot_mqtt_interface.h.
| char* pRootCALocation |
Pointer to a string defining the Root CA file (full file, not path)
Definition at line 86 of file aws_iot_mqtt_interface.h.
| char* pUserName |
Not used in the AWS IoT Service.
Definition at line 90 of file aws_iot_mqtt_interface.h.
| uint32_t tlsHandshakeTimeout_ms |
TLS handshake timeout. In milliseconds.
Definition at line 98 of file aws_iot_mqtt_interface.h.
MQTT LWT parameters.
Definition at line 96 of file aws_iot_mqtt_interface.h.
Generated on Tue Jul 12 2022 22:13:21 by
1.7.2