4.2.0.0R6
Software Development Kit
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules
ltrx_mqtt_client.h File Reference

Definitions related to MQTT client. More...

Data Structures

struct  ltrx_mqtt_client_connect_info
 Contains MQTT client connection information. More...
 
struct  ltrx_mqtt_client_network_info
 Contains MQTT client network information. More...
 
struct  ltrx_mqtt_len_string
 MQTT length string. More...
 
struct  ltrx_mqtt_message
 Contains MQTT client message information. More...
 
struct  ltrx_mqtt_message_data
 MQTT message data. More...
 
struct  ltrx_mqtt_string
 MQTT string. More...
 

Enumerations

enum  ltrx_mqtt_client_protocol {
  LTRX_MQTT_CLIENT_PROTOCOL__UNREGISTERED, LTRX_MQTT_CLIENT_PROTOCOL__TCP, LTRX_MQTT_CLIENT_PROTOCOL__TLS, LTRX_MQTT_CLIENT_PROTOCOL__WEBSOCKET,
  LTRX_MQTT_CLIENT_PROTOCOL__WEBSOCKET_SECURE
}
 MQTT client protocols. More...
 
enum  ltrx_mqtt_client_return_code {
  LTRX_MQTT_CLIENT_RC__SUCCESS = 0, LTRX_MQTT_CLIENT_RC__INVALID_PARAMETER = -1, LTRX_MQTT_CLIENT_RC__INVALID_CONFIG_ITEM = -2, LTRX_MQTT_CLIENT_RC__NOT_ENOUGH_MEMORY = -3,
  LTRX_MQTT_CLIENT_RC__INVALID_STATE = -4, LTRX_MQTT_CLIENT_RC__PROTOCOL_ERROR = -5, LTRX_MQTT_CLIENT_RC__NET_OPEN_FAILURE = -6, LTRX_MQTT_CLIENT_RC__THREAD_FAILURE = -7,
  LTRX_MQTT_CLIENT_RC__MQTT_CONNECT_FAILURE = -8, LTRX_MQTT_CLIENT_RC__HTTP_ERROR_RESPONSE = -9, LTRX_MQTT_CLIENT_RC__OTHER_FAILURE = -10
}
 MQTT client Return codes. More...
 
enum  ltrx_mqtt_qos { LTRX_MQTT_QOS0 = 0, LTRX_MQTT_QOS1 = 1, LTRX_MQTT_QOS2 = 2 }
 MQTT QoS levels. More...
 
enum  ltrx_mqtt_version { LTRX_MQTT_VERSION_3_1 = 3, LTRX_MQTT_VERSION_3_1_1 = 4 }
 Supported MQTT versions. More...
 

Detailed Description

Definitions related to MQTT client.

Enumeration Type Documentation

MQTT client protocols.

Enumerator
LTRX_MQTT_CLIENT_PROTOCOL__UNREGISTERED 

Unregistered.

LTRX_MQTT_CLIENT_PROTOCOL__TCP 

TCP.

LTRX_MQTT_CLIENT_PROTOCOL__TLS 

TLS.

LTRX_MQTT_CLIENT_PROTOCOL__WEBSOCKET 

Websocket.

LTRX_MQTT_CLIENT_PROTOCOL__WEBSOCKET_SECURE 

Websocket secure.

MQTT client Return codes.

Enumerator
LTRX_MQTT_CLIENT_RC__SUCCESS 

Success.

LTRX_MQTT_CLIENT_RC__INVALID_PARAMETER 

Invalid parameter.

LTRX_MQTT_CLIENT_RC__INVALID_CONFIG_ITEM 

Invalid configuration item.

LTRX_MQTT_CLIENT_RC__NOT_ENOUGH_MEMORY 

Insufficient memory.

LTRX_MQTT_CLIENT_RC__INVALID_STATE 

Invalid state.

LTRX_MQTT_CLIENT_RC__PROTOCOL_ERROR 

Protocol error.

LTRX_MQTT_CLIENT_RC__NET_OPEN_FAILURE 

Network error.

LTRX_MQTT_CLIENT_RC__THREAD_FAILURE 

Thread failure.

LTRX_MQTT_CLIENT_RC__MQTT_CONNECT_FAILURE 

Connect failed.

LTRX_MQTT_CLIENT_RC__HTTP_ERROR_RESPONSE 

HTTP error received.

LTRX_MQTT_CLIENT_RC__OTHER_FAILURE 

Unknown error.

MQTT QoS levels.

Enumerator
LTRX_MQTT_QOS0 

At most once.

LTRX_MQTT_QOS1 

At least once.

LTRX_MQTT_QOS2 

Exactly once.

Supported MQTT versions.

Enumerator
LTRX_MQTT_VERSION_3_1 

Protocol "MQIsdp"

LTRX_MQTT_VERSION_3_1_1 

Protocol "MQTT"