Structures and Enumerations

General Description

mqtt library data structures and type definitions

Data Structures
struct	cy_mqtt_subscribe_info_t
	MQTT subscribe information structure. More...
struct	cy_mqtt_publish_info_t
	MQTT publish information structure. More...
struct	cy_mqtt_broker_info_t
	MQTT broker information structure. More...
struct	cy_mqtt_connect_info_t
	MQTT connect information structure. More...
struct	cy_mqtt_message_t
	Received MQTT publish message information structure. More...
struct	cy_mqtt_event_t
	MQTT event information structure. More...

Typedefs
typedef cy_mqtt_publish_info_t	cy_mqtt_received_msg_info_t
	MQTT received message information structure. More...
typedef cy_mqtt_subscribe_info_t	cy_mqtt_unsubscribe_info_t
	MQTT unsubscribe information structure.

Enumerations
enum	cy_mqtt_qos_t {   CY_MQTT_QOS0 = 0 ,   CY_MQTT_QOS1 = 1 ,   CY_MQTT_QOS2 = 2 ,   CY_MQTT_QOS_INVALID = -1 }
	MQTT QoS levels. More...
enum	cy_mqtt_event_type_t {   CY_MQTT_EVENT_TYPE_SUBSCRIPTION_MESSAGE_RECEIVE = 0 ,   CY_MQTT_EVENT_TYPE_DISCONNECT = 1 ,   CY_MQTT_EVENT_TYPE_PINGRESP = 2 }
	MQTT event types. More...
enum	cy_mqtt_disconn_type_t {   CY_MQTT_DISCONN_TYPE_BROKER_DOWN = 0 ,   CY_MQTT_DISCONN_TYPE_NETWORK_DOWN = 1 ,   CY_MQTT_DISCONN_TYPE_BAD_RESPONSE = 2 ,   CY_MQTT_DISCONN_TYPE_SND_RCV_FAIL = 3 }
	MQTT disconnect type. More...

Typedef Documentation

cy_mqtt_received_msg_info_t

typedef cy_mqtt_publish_info_t cy_mqtt_received_msg_info_t

MQTT received message information structure.

Note

This type is defined for improving readability and for library backward compatibility.

Enumeration Type Documentation

cy_mqtt_qos_t

enum cy_mqtt_qos_t

MQTT QoS levels.

Enumerator
CY_MQTT_QOS0	Delivery at most once.
CY_MQTT_QOS1	Delivery at least once.
CY_MQTT_QOS2	Delivery exactly once.
CY_MQTT_QOS_INVALID	Invalid QoS.

cy_mqtt_event_type_t

enum cy_mqtt_event_type_t

MQTT event types.

Enumerator
CY_MQTT_EVENT_TYPE_SUBSCRIPTION_MESSAGE_RECEIVE	Message from the subscribed topic.
CY_MQTT_EVENT_TYPE_DISCONNECT	Disconnected from MQTT broker.

cy_mqtt_disconn_type_t

enum cy_mqtt_disconn_type_t

MQTT disconnect type.

Enumerator
CY_MQTT_DISCONN_TYPE_BROKER_DOWN	Keep-alive not received from broker, possibly broker is down
CY_MQTT_DISCONN_TYPE_NETWORK_DOWN	Network is disconnected.
CY_MQTT_DISCONN_TYPE_BAD_RESPONSE	Bad response from MQTT broker. possibly received MQTT packet with invalid packet type ID
CY_MQTT_DISCONN_TYPE_SND_RCV_FAIL	MQTT packet send or receive operation failed due to network latency (or) send/receive related timeouts.