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.
IoT_Client_Init_Params Struct Reference
MQTT Initialization Parameters. More...
#include <aws_iot_mqtt_client.h>
Data Fields | |
| bool | 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) | |
| uint32_t | mqttPacketTimeout_ms |
| Timeout for reading a complete MQTT packet. In milliseconds. | |
| 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. | |
| void * | disconnectHandlerData |
| Data to pass as argument when disconnect handler is called. | |
| bool | isBlockOnThreadLockEnabled |
| Timeout for Thread blocking calls. Set to 0 to block until lock is obtained. In milliseconds. | |
Detailed Description
MQTT Initialization Parameters.
Defining a type for MQTT initialization parameters. Passed into client when to initialize the client
Definition at line 165 of file aws_iot_mqtt_client.h.
Field Documentation
Callback to be invoked upon connection loss.
Definition at line 176 of file aws_iot_mqtt_client.h.
| void* disconnectHandlerData |
Data to pass as argument when disconnect handler is called.
Definition at line 177 of file aws_iot_mqtt_client.h.
| bool enableAutoReconnect |
Set to true to enable auto reconnect.
Definition at line 166 of file aws_iot_mqtt_client.h.
Timeout for Thread blocking calls. Set to 0 to block until lock is obtained. In milliseconds.
Definition at line 179 of file aws_iot_mqtt_client.h.
| bool isSSLHostnameVerify |
Client should perform server certificate hostname validation.
Definition at line 175 of file aws_iot_mqtt_client.h.
| uint32_t mqttCommandTimeout_ms |
Timeout for MQTT blocking calls. In milliseconds.
Definition at line 173 of file aws_iot_mqtt_client.h.
| uint32_t mqttPacketTimeout_ms |
Timeout for reading a complete MQTT packet. In milliseconds.
Definition at line 172 of file aws_iot_mqtt_client.h.
| char* pDeviceCertLocation |
Pointer to a string defining the device identity certificate file (full file, not path)
Definition at line 170 of file aws_iot_mqtt_client.h.
Pointer to a string defining the device private key file (full file, not path)
Definition at line 171 of file aws_iot_mqtt_client.h.
| char* pHostURL |
Pointer to a string defining the endpoint for the MQTT service.
Definition at line 167 of file aws_iot_mqtt_client.h.
| uint16_t port |
MQTT service listening port.
Definition at line 168 of file aws_iot_mqtt_client.h.
| char* pRootCALocation |
Pointer to a string defining the Root CA file (full file, not path)
Definition at line 169 of file aws_iot_mqtt_client.h.
| uint32_t tlsHandshakeTimeout_ms |
TLS handshake timeout. In milliseconds.
Definition at line 174 of file aws_iot_mqtt_client.h.
Generated on Tue Jul 12 2022 19:02:39 by
1.7.2