MQTT client library
cy_mqtt_connect_info_t Struct Reference

Description

MQTT connect information structure.

Data Fields

const char * client_id
 MQTT client identifier. More...
 
uint16_t client_id_len
 Length of the client identifier.
 
const char * username
 MQTT user name. More...
 
uint16_t username_len
 Length of MQTT user name. More...
 
const char * password
 MQTT password. More...
 
uint16_t password_len
 Length of MQTT password. More...
 
bool clean_session
 Whether to establish a new, clean session or resume a previous session.
 
uint16_t keep_alive_sec
 MQTT keep alive period.
 
cy_mqtt_publish_info_twill_info
 MQTT will message. More...
 

Field Documentation

◆ client_id

const char* cy_mqtt_connect_info_t::client_id

MQTT client identifier.

Must be unique per client. This memory needs to be maintained until MQTT object is deleted.

◆ username

const char* cy_mqtt_connect_info_t::username

MQTT user name.

Set to NULL if not used. This memory needs to be maintained until MQTT object is deleted.

◆ username_len

uint16_t cy_mqtt_connect_info_t::username_len

Length of MQTT user name.

Set to 0 if not used.

◆ password

const char* cy_mqtt_connect_info_t::password

MQTT password.

Set to NULL if not used. This memory needs to be maintained until MQTT object is deleted.

◆ password_len

uint16_t cy_mqtt_connect_info_t::password_len

Length of MQTT password.

Set to 0 if not used.

◆ will_info

cy_mqtt_publish_info_t* cy_mqtt_connect_info_t::will_info

MQTT will message.

This will info can be NULL.