MQTT Client Configuration structure.
This structure holds the configuration parameters for the MQTT client, including connection settings, retry policies, session options, and security credentials.
Public Attributes#
Whether to automatically reconnect to the broker in case of disconnection.
Maximum number of retry attempts for auto reconnect.
Minimum back-off time (in seconds) between two successive reconnect attempts.
Maximum back-off time (in seconds) between two successive reconnect attempts.
Clean session flag to send to the broker in the connect request.
MQTT protocol version used by the client.
Port number used by the client for the connection.
Credential ID for the username and password used in the MQTT connect request.
Pointer to the MQTT client ID string.
Length of the client ID string. Should not exceed 60 bytes including NULL termination character.
TLS flags for various MQTT options. See sl_mqtt_tls_flag_t for details.
Public Attribute Documentation#
auto_reconnect#
bool sl_mqtt_client_configuration_t::auto_reconnect
Whether to automatically reconnect to the broker in case of disconnection.
241 of file components/service/mqtt/inc/sl_mqtt_client_types.hretry_count#
uint8_t sl_mqtt_client_configuration_t::retry_count
Maximum number of retry attempts for auto reconnect.
242 of file components/service/mqtt/inc/sl_mqtt_client_types.hminimum_back_off_time#
uint16_t sl_mqtt_client_configuration_t::minimum_back_off_time
Minimum back-off time (in seconds) between two successive reconnect attempts.
243 of file components/service/mqtt/inc/sl_mqtt_client_types.hmaximum_back_off_time#
uint16_t sl_mqtt_client_configuration_t::maximum_back_off_time
Maximum back-off time (in seconds) between two successive reconnect attempts.
244 of file components/service/mqtt/inc/sl_mqtt_client_types.his_clean_session#
bool sl_mqtt_client_configuration_t::is_clean_session
Clean session flag to send to the broker in the connect request.
245 of file components/service/mqtt/inc/sl_mqtt_client_types.hmqt_version#
sl_mqtt_version_t sl_mqtt_client_configuration_t::mqt_version
MQTT protocol version used by the client.
246 of file components/service/mqtt/inc/sl_mqtt_client_types.hclient_port#
uint16_t sl_mqtt_client_configuration_t::client_port
Port number used by the client for the connection.
247 of file components/service/mqtt/inc/sl_mqtt_client_types.hcredential_id#
sl_net_credential_id_t sl_mqtt_client_configuration_t::credential_id
Credential ID for the username and password used in the MQTT connect request.
249 of file components/service/mqtt/inc/sl_mqtt_client_types.hclient_id#
uint8_t* sl_mqtt_client_configuration_t::client_id
Pointer to the MQTT client ID string.
250 of file components/service/mqtt/inc/sl_mqtt_client_types.hclient_id_length#
uint8_t sl_mqtt_client_configuration_t::client_id_length
Length of the client ID string. Should not exceed 60 bytes including NULL termination character.
252 of file components/service/mqtt/inc/sl_mqtt_client_types.htls_flags#
sl_mqtt_tls_flag_t sl_mqtt_client_configuration_t::tls_flags
TLS flags for various MQTT options. See sl_mqtt_tls_flag_t for details.
253 of file components/service/mqtt/inc/sl_mqtt_client_types.h