lws-mqtt.h File Reference

Go to the source code of this file.

Data Structures
union	lws_mqtt_fixed_hdr_t
struct	lws_mqtt_qos2_state_ops
struct	lws_mqtt_client_connect_param_s
struct	lws_mqtt_publish_param_s
struct	topic_elem
struct	lws_mqtt_subscribe_param_s
struct	lws_mqtt_fixed_hdr_t.flags
struct	lws_mqtt_client_connect_param_s.will_param
struct	lws_mqtt_client_connect_param_s.birth_param

Macros
#define	MQTT_VER_3_1_1   4
#define	MQTT_VER_STRING   "3.1.1"
#define	LWS_MQTT_FINAL_PART   1
#define	LWS_MQTT_MAX_AWSIOT_TOPICLEN   256
#define	LWS_MQTT_MAX_TOPICLEN   65535
#define	LWS_MQTT_MAX_PACKET_SIZE   (1 * 1024 * 1024)
#define	LWS_MQTT_MAX_CIDLEN   128
#define	LWS_MQTT_RANDOM_CIDLEN
#define	LWS_MQTT_SHADOW_MAX_THING_LEN   128
#define	LWS_MQTT_SHADOW_MAX_SHADOW_LEN   64
#define	LWS_MQTT_SHADOW_UPDATE_STR   "/update"
#define	LWS_MQTT_SHADOW_DELETE_STR   "/delete"
#define	LWS_MQTT_SHADOW_GET_STR   "/get"
#define	LWS_MQTT_SHADOW_RESP_ACCEPTED_STR   "/accepted"
#define	LWS_MQTT_SHADOW_RESP_REJECTED_STR   "/rejected"
#define	LWS_MQTT_SHADOW_RESP_DELTA_STR   "/delta"
#define	LWS_MQTT_SHADOW_RESP_DOCUMENT_STR   "/documents"
#define	LWS_MQTT_SHADOW_UPDATE_ACCEPTED_STR   LWS_MQTT_SHADOW_UPDATE_STR LWS_MQTT_SHADOW_RESP_ACCEPTED_STR
#define	LWS_MQTT_SHADOW_UPDATE_REJECTED_STR   LWS_MQTT_SHADOW_UPDATE_STR LWS_MQTT_SHADOW_RESP_REJECTED_STR
#define	LWS_MQTT_SHADOW_UPDATE_DELTA_STR   LWS_MQTT_SHADOW_UPDATE_STR LWS_MQTT_SHADOW_RESP_DELTA_STR
#define	LWS_MQTT_SHADOW_UPDATE_DOCUMENT_STR   LWS_MQTT_SHADOW_UPDATE_STR LWS_MQTT_SHADOW_RESP_DOCUMENT_STR
#define	LWS_MQTT_SHADOW_DELETE_ACCEPTED_STR   LWS_MQTT_SHADOW_DELETE_STR LWS_MQTT_SHADOW_RESP_ACCEPTED_STR
#define	LWS_MQTT_SHADOW_DELETE_REJECTED_STR   LWS_MQTT_SHADOW_DELETE_STR LWS_MQTT_SHADOW_RESP_REJECTED_STR
#define	LWS_MQTT_SHADOW_GET_ACCEPTED_STR   LWS_MQTT_SHADOW_GET_STR LWS_MQTT_SHADOW_RESP_ACCEPTED_STR
#define	LWS_MQTT_SHADOW_GET_REJECTED_STR   LWS_MQTT_SHADOW_GET_STR LWS_MQTT_SHADOW_RESP_REJECTED_STR
#define	LWS_MQTT_SHADOW_PREFIX_FORMAT   "$aws/things/%s"
#define	LWS_MQTT_SHADOW_NAMED_SHADOW_TOPIC_FORMAT   LWS_MQTT_SHADOW_PREFIX_FORMAT "/shadow/name/%s%s"
#define	LWS_MQTT_SHADOW_UNNAMED_SHADOW_TOPIC_FORMAT   LWS_MQTT_SHADOW_PREFIX_FORMAT "/shadow%s"
#define	LWS_MQTT_SHADOW_UNNAMED_TOPIC_MATCH   "$aws/things/+/shadow/+"
#define	LWS_MQTT_SHADOW_NAMED_TOPIC_MATCH   "$aws/things/+/shadow/name/+/+"
#define	LWS_MQTT_MAX_TOPICS   8

Typedefs
typedef struct _lws_mqtt_related	lws_mqtt_related_t
typedef struct lws_mqtt_str_st	lws_mqtt_str_t
typedef struct lws_mqtt_qos2_state_ops	lws_mqtt_qos2_state_ops_t
typedef struct lws_mqtt_client_connect_param_s	lws_mqtt_client_connect_param_t
typedef struct lws_mqtt_publish_param_s	lws_mqtt_publish_param_t
typedef struct topic_elem	lws_mqtt_topic_elem_t
typedef struct lws_mqtt_subscribe_param_s	lws_mqtt_subscribe_param_t

Enumerations
enum	lws_mqtt_qos_levels_t {   QOS0 , QOS1 , QOS2 , RESERVED_QOS_LEVEL ,   FAILURE_QOS_LEVEL = 0x80 }
enum	lws_mqtt_control_packet_t {   LMQCP_RESERVED , LMQCP_CTOS_CONNECT , LMQCP_STOC_CONNACK , LMQCP_PUBLISH ,   LMQCP_PUBACK , LMQCP_PUBREC , LMQCP_PUBREL , LMQCP_PUBCOMP ,   LMQCP_CTOS_SUBSCRIBE , LMQCP_STOC_SUBACK , LMQCP_CTOS_UNSUBSCRIBE , LMQCP_STOC_UNSUBACK ,   LMQCP_CTOS_PINGREQ , LMQCP_STOC_PINGRESP , LMQCP_DISCONNECT , LMQCP_AUTH }
enum	lws_mqtt_connect_flags_t {   LMQCFT_USERNAME_NOFREE = (1 << 10) , LMQCFT_PASSWORD_NOFREE = (1 << 9) , LMQCFT_CLIENT_ID_NOFREE = (1 << 8) , LMQCFT_USERNAME = (1 << 7) ,   LMQCFT_PASSWORD = (1 << 6) , LMQCFT_WILL_RETAIN = (1 << 5) , LMQCFT_WILL_QOS = (1 << 3) , LMQCFT_WILL_FLAG = (1 << 2) ,   LMQCFT_CLEAN_START = (1 << 1) , LMQCFT_RESERVED = (1 << 0) , LMQCFT_WILL_QOS_MASK = (3 << 3) }
enum	lws_mqtt_connack_flags_t { LMQCFT_SESSION_PRESENT = (1 << 0) }
enum	lws_mqtt_reason_t {   LMQCP_REASON_SUCCESS = 0x00 , LMQCP_REASON_NORMAL_DISCONNECTION = 0x00 , LMQCP_REASON_GRANTED_QOS0 = 0x00 , LMQCP_REASON_GRANTED_QOS1 = 0x01 ,   LMQCP_REASON_GRANTED_QOS2 = 0x02 , LMQCP_REASON_DISCONNECT_WILL = 0x04 , LMQCP_REASON_NO_MATCHING_SUBSCRIBER = 0x10 , LMQCP_REASON_NO_SUBSCRIPTION_EXISTED = 0x11 ,   LMQCP_REASON_CONTINUE_AUTHENTICATION = 0x18 , LMQCP_REASON_RE_AUTHENTICATE = 0x19 , LMQCP_REASON_UNSPECIFIED_ERROR = 0x80 , LMQCP_REASON_MALFORMED_PACKET = 0x81 ,   LMQCP_REASON_PROTOCOL_ERROR = 0x82 , LMQCP_REASON_IMPLEMENTATION_SPECIFIC_ERROR = 0x83 , LMQCP_REASON_UNSUPPORTED_PROTOCOL = 0x84 , LMQCP_REASON_CLIENT_ID_INVALID = 0x85 ,   LMQCP_REASON_BAD_CREDENTIALS = 0x86 , LMQCP_REASON_NOT_AUTHORIZED = 0x87 , LMQCP_REASON_SERVER_UNAVAILABLE = 0x88 , LMQCP_REASON_SERVER_BUSY = 0x89 ,   LMQCP_REASON_BANNED = 0x8a , LMQCP_REASON_SERVER_SHUTTING_DOWN = 0x8b , LMQCP_REASON_BAD_AUTHENTICATION_METHOD = 0x8c , LMQCP_REASON_KEEPALIVE_TIMEOUT = 0x8d ,   LMQCP_REASON_SESSION_TAKEN_OVER = 0x8e , LMQCP_REASON_TOPIC_FILTER_INVALID = 0x8f , LMQCP_REASON_TOPIC_NAME_INVALID = 0x90 , LMQCP_REASON_PACKET_ID_IN_USE = 0x91 ,   LMQCP_REASON_PACKET_ID_NOT_FOUND = 0x92 , LMQCP_REASON_MAX_RX_EXCEEDED = 0x93 , LMQCP_REASON_TOPIC_ALIAS_INVALID = 0x94 , LMQCP_REASON_PACKET_TOO_LARGE = 0x95 ,   LMQCP_REASON_RATELIMIT = 0x96 , LMQCP_REASON_QUOTA_EXCEEDED = 0x97 , LMQCP_REASON_ADMINISTRATIVE_ACTION = 0x98 , LMQCP_REASON_PAYLOAD_FORMAT_INVALID = 0x99 ,   LMQCP_REASON_RETAIN_NOT_SUPPORTED = 0x9a , LMQCP_REASON_QOS_NOT_SUPPORTED = 0x9b , LMQCP_REASON_USE_ANOTHER_SERVER = 0x9c , LMQCP_REASON_SERVER_MOVED = 0x9d ,   LMQCP_REASON_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED = 0x9e , LMQCP_REASON_CONNECTION_RATE_EXCEEDED = 0x9f , LMQCP_REASON_MAXIMUM_CONNECT_TIME = 0xa0 , LMQCP_REASON_SUBSCRIPTION_IDS_NOT_SUPPORTED = 0xa1 ,   LMQCP_REASON_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED = 0xa2 }
enum	lws_mqtt_property {   LMQPROP_INVALID , LMQPROP_PAYLOAD_FORMAT_INDICATOR = 0x01 , LMQPROP_MESSAGE_EXPIRY_INTERVAL = 0x02 , LMQPROP_CONTENT_TYPE = 0x03 ,   LMQPROP_RESPONSE_TOPIC = 0x08 , LMQPROP_CORRELATION_DATA = 0x09 , LMQPROP_SUBSCRIPTION_IDENTIFIER = 0x0b , LMQPROP_SESSION_EXPIRY_INTERVAL = 0x11 ,   LMQPROP_ASSIGNED_CLIENT_IDENTIFIER = 0x12 , LMQPROP_SERVER_KEEP_ALIVE = 0x13 , LMQPROP_AUTHENTICATION_METHOD = 0x15 , LMQPROP_AUTHENTICATION_DATA = 0x16 ,   LMQPROP_REQUEST_PROBLEM_INFORMATION = 0x17 , LMQPROP_WILL_DELAY_INTERVAL = 0x18 , LMQPROP_REQUEST_RESPONSE_INFORMATION = 0x19 , LMQPROP_RESPONSE_INFORMATION = 0x1a ,   LMQPROP_SERVER_REFERENCE = 0x1c , LMQPROP_REASON_STRING = 0x1f , LMQPROP_RECEIVE_MAXIMUM = 0x21 , LMQPROP_TOPIC_ALIAS_MAXIMUM = 0x22 ,   LMQPROP_TOPIC_ALIAS = 0x23 , LMQPROP_MAXIMUM_QOS = 0x24 , LMQPROP_RETAIN_AVAILABLE = 0x25 , LMQPROP_USER_PROPERTY = 0x26 ,   LMQPROP_MAXIMUM_PACKET_SIZE = 0x27 , LMQPROP_WILDCARD_SUBSCRIPTION_AVAIL = 0x28 , LMQPROP_SUBSCRIPTION_IDENTIFIER_AVAIL = 0x29 , LMQPROP_SHARED_SUBSCRIPTION_AVAIL = 0x2a }

Functions
LWS_VISIBLE LWS_EXTERN int	lws_mqtt_bindata_cmp (const lws_mqtt_str_t *bd1, const lws_mqtt_str_t *bd2)
LWS_VISIBLE LWS_EXTERN void	lws_mqtt_str_init (lws_mqtt_str_t *s, uint8_t *buf, uint16_t lim, char nf)
LWS_VISIBLE LWS_EXTERN lws_mqtt_str_t *	lws_mqtt_str_create (uint16_t lim)
LWS_VISIBLE LWS_EXTERN lws_mqtt_str_t *	lws_mqtt_str_create_init (uint8_t *buf, uint16_t len, uint16_t lim)
LWS_VISIBLE LWS_EXTERN lws_mqtt_str_t *	lws_mqtt_str_create_cstr_dup (const char *buf, uint16_t lim)
LWS_VISIBLE LWS_EXTERN uint8_t *	lws_mqtt_str_next (lws_mqtt_str_t *s, uint16_t *budget)
LWS_VISIBLE LWS_EXTERN int	lws_mqtt_str_advance (lws_mqtt_str_t *s, int n)
LWS_VISIBLE LWS_EXTERN void	lws_mqtt_str_free (lws_mqtt_str_t **s)
LWS_VISIBLE LWS_EXTERN int	lws_mqtt_client_send_publish (struct lws *wsi, lws_mqtt_publish_param_t *pub, const void *buf, uint32_t len, int final)
LWS_VISIBLE LWS_EXTERN int	lws_mqtt_client_send_subcribe (struct lws *wsi, lws_mqtt_subscribe_param_t *sub)
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT	lws_mqtt_client_send_unsubcribe (struct lws *wsi, const lws_mqtt_subscribe_param_t *unsub)
LWS_VISIBLE LWS_EXTERN int	lws_mqtt_client_qos2_rx_add (struct lws *wsi, uint16_t pkt_id)

---

Data Structure Documentation

lws_mqtt_publish_param_s

struct lws_mqtt_publish_param_s

Definition at line 137 of file lws-mqtt.h.

Collaboration diagram for lws_mqtt_publish_param_s:

Data Fields
char *	topic
uint16_t	topic_len
const void *	payload
uint32_t	payload_len
uint32_t	payload_pos
lws_mqtt_qos_levels_t	qos
uint16_t	packet_id
uint8_t	dup:1
uint8_t	retain:1

topic_elem

struct topic_elem

Definition at line 154 of file lws-mqtt.h.

Collaboration diagram for topic_elem:

Data Fields
const char *	name
lws_mqtt_qos_levels_t	qos
uint8_t	acked

lws_mqtt_subscribe_param_s

struct lws_mqtt_subscribe_param_s

Definition at line 174 of file lws-mqtt.h.

Collaboration diagram for lws_mqtt_subscribe_param_s:

Data Fields
uint32_t	num_topics
lws_mqtt_topic_elem_t *	topic
uint16_t	packet_id

lws_mqtt_fixed_hdr_t.flags

struct lws_mqtt_fixed_hdr_t.flags

Definition at line 82 of file lws-mqtt.h.

Collaboration diagram for lws_mqtt_fixed_hdr_t.flags:

Data Fields
uint8_t	retain:1
uint8_t	qos:2
uint8_t	dup:1
uint8_t	ctrl_pkt_type:4

lws_mqtt_client_connect_param_s.will_param

struct lws_mqtt_client_connect_param_s.will_param

Definition at line 114 of file lws-mqtt.h.

Collaboration diagram for lws_mqtt_client_connect_param_s.will_param:

Data Fields
const char *	topic
const char *	message
lws_mqtt_qos_levels_t	qos
uint8_t	retain

lws_mqtt_client_connect_param_s.birth_param

struct lws_mqtt_client_connect_param_s.birth_param

Definition at line 121 of file lws-mqtt.h.

Collaboration diagram for lws_mqtt_client_connect_param_s.birth_param:

Data Fields
const char *	topic
const char *	message
lws_mqtt_qos_levels_t	qos
uint8_t	retain

Macro Definition Documentation

MQTT_VER_3_1_1

#define MQTT_VER_3_1_1   4

Definition at line 35 of file lws-mqtt.h.

MQTT_VER_STRING

#define MQTT_VER_STRING   "3.1.1"

Definition at line 37 of file lws-mqtt.h.

LWS_MQTT_FINAL_PART

#define LWS_MQTT_FINAL_PART   1

Definition at line 42 of file lws-mqtt.h.

LWS_MQTT_MAX_AWSIOT_TOPICLEN

#define LWS_MQTT_MAX_AWSIOT_TOPICLEN   256

Definition at line 44 of file lws-mqtt.h.

LWS_MQTT_MAX_TOPICLEN

#define LWS_MQTT_MAX_TOPICLEN   65535

Definition at line 45 of file lws-mqtt.h.

LWS_MQTT_MAX_PACKET_SIZE

#define LWS_MQTT_MAX_PACKET_SIZE   (1 * 1024 * 1024)

Definition at line 46 of file lws-mqtt.h.

LWS_MQTT_MAX_CIDLEN

#define LWS_MQTT_MAX_CIDLEN   128

Definition at line 47 of file lws-mqtt.h.

LWS_MQTT_RANDOM_CIDLEN

#define LWS_MQTT_RANDOM_CIDLEN

Value:

23 /* 3.1.3.1-5: Server MUST... between
1 and 23 chars... */

Definition at line 48 of file lws-mqtt.h.

LWS_MQTT_SHADOW_MAX_THING_LEN

#define LWS_MQTT_SHADOW_MAX_THING_LEN   128

Definition at line 50 of file lws-mqtt.h.

LWS_MQTT_SHADOW_MAX_SHADOW_LEN

#define LWS_MQTT_SHADOW_MAX_SHADOW_LEN   64

Definition at line 51 of file lws-mqtt.h.

LWS_MQTT_SHADOW_UPDATE_STR

#define LWS_MQTT_SHADOW_UPDATE_STR   "/update"

Definition at line 52 of file lws-mqtt.h.

LWS_MQTT_SHADOW_DELETE_STR

#define LWS_MQTT_SHADOW_DELETE_STR   "/delete"

Definition at line 53 of file lws-mqtt.h.

LWS_MQTT_SHADOW_GET_STR

#define LWS_MQTT_SHADOW_GET_STR   "/get"

Definition at line 54 of file lws-mqtt.h.

LWS_MQTT_SHADOW_RESP_ACCEPTED_STR

#define LWS_MQTT_SHADOW_RESP_ACCEPTED_STR   "/accepted"

Definition at line 55 of file lws-mqtt.h.

LWS_MQTT_SHADOW_RESP_REJECTED_STR

#define LWS_MQTT_SHADOW_RESP_REJECTED_STR   "/rejected"

Definition at line 56 of file lws-mqtt.h.

LWS_MQTT_SHADOW_RESP_DELTA_STR

#define LWS_MQTT_SHADOW_RESP_DELTA_STR   "/delta"

Definition at line 57 of file lws-mqtt.h.

LWS_MQTT_SHADOW_RESP_DOCUMENT_STR

#define LWS_MQTT_SHADOW_RESP_DOCUMENT_STR   "/documents"

Definition at line 58 of file lws-mqtt.h.

LWS_MQTT_SHADOW_UPDATE_ACCEPTED_STR

#define LWS_MQTT_SHADOW_UPDATE_ACCEPTED_STR   LWS_MQTT_SHADOW_UPDATE_STR LWS_MQTT_SHADOW_RESP_ACCEPTED_STR

Definition at line 59 of file lws-mqtt.h.

LWS_MQTT_SHADOW_UPDATE_REJECTED_STR

#define LWS_MQTT_SHADOW_UPDATE_REJECTED_STR   LWS_MQTT_SHADOW_UPDATE_STR LWS_MQTT_SHADOW_RESP_REJECTED_STR

Definition at line 60 of file lws-mqtt.h.

LWS_MQTT_SHADOW_UPDATE_DELTA_STR

#define LWS_MQTT_SHADOW_UPDATE_DELTA_STR   LWS_MQTT_SHADOW_UPDATE_STR LWS_MQTT_SHADOW_RESP_DELTA_STR

Definition at line 61 of file lws-mqtt.h.

LWS_MQTT_SHADOW_UPDATE_DOCUMENT_STR

#define LWS_MQTT_SHADOW_UPDATE_DOCUMENT_STR   LWS_MQTT_SHADOW_UPDATE_STR LWS_MQTT_SHADOW_RESP_DOCUMENT_STR

Definition at line 62 of file lws-mqtt.h.

LWS_MQTT_SHADOW_DELETE_ACCEPTED_STR

#define LWS_MQTT_SHADOW_DELETE_ACCEPTED_STR   LWS_MQTT_SHADOW_DELETE_STR LWS_MQTT_SHADOW_RESP_ACCEPTED_STR

Definition at line 63 of file lws-mqtt.h.

LWS_MQTT_SHADOW_DELETE_REJECTED_STR

#define LWS_MQTT_SHADOW_DELETE_REJECTED_STR   LWS_MQTT_SHADOW_DELETE_STR LWS_MQTT_SHADOW_RESP_REJECTED_STR

Definition at line 64 of file lws-mqtt.h.

LWS_MQTT_SHADOW_GET_ACCEPTED_STR

#define LWS_MQTT_SHADOW_GET_ACCEPTED_STR   LWS_MQTT_SHADOW_GET_STR LWS_MQTT_SHADOW_RESP_ACCEPTED_STR

Definition at line 65 of file lws-mqtt.h.

LWS_MQTT_SHADOW_GET_REJECTED_STR

#define LWS_MQTT_SHADOW_GET_REJECTED_STR   LWS_MQTT_SHADOW_GET_STR LWS_MQTT_SHADOW_RESP_REJECTED_STR

Definition at line 66 of file lws-mqtt.h.

LWS_MQTT_SHADOW_PREFIX_FORMAT

#define LWS_MQTT_SHADOW_PREFIX_FORMAT   "$aws/things/%s"

Definition at line 67 of file lws-mqtt.h.

LWS_MQTT_SHADOW_NAMED_SHADOW_TOPIC_FORMAT

#define LWS_MQTT_SHADOW_NAMED_SHADOW_TOPIC_FORMAT   LWS_MQTT_SHADOW_PREFIX_FORMAT "/shadow/name/%s%s"

Definition at line 68 of file lws-mqtt.h.

LWS_MQTT_SHADOW_UNNAMED_SHADOW_TOPIC_FORMAT

#define LWS_MQTT_SHADOW_UNNAMED_SHADOW_TOPIC_FORMAT   LWS_MQTT_SHADOW_PREFIX_FORMAT "/shadow%s"

Definition at line 69 of file lws-mqtt.h.

LWS_MQTT_SHADOW_UNNAMED_TOPIC_MATCH

#define LWS_MQTT_SHADOW_UNNAMED_TOPIC_MATCH   "$aws/things/+/shadow/+"

Definition at line 70 of file lws-mqtt.h.

LWS_MQTT_SHADOW_NAMED_TOPIC_MATCH

#define LWS_MQTT_SHADOW_NAMED_TOPIC_MATCH   "$aws/things/+/shadow/name/+/+"

Definition at line 71 of file lws-mqtt.h.

LWS_MQTT_MAX_TOPICS

#define LWS_MQTT_MAX_TOPICS   8

Definition at line 169 of file lws-mqtt.h.

Typedef Documentation

lws_mqtt_related_t

typedef struct _lws_mqtt_related lws_mqtt_related_t

Definition at line 31 of file lws-mqtt.h.

lws_mqtt_str_t

typedef struct lws_mqtt_str_st lws_mqtt_str_t

Definition at line 33 of file lws-mqtt.h.

lws_mqtt_qos2_state_ops_t

typedef struct lws_mqtt_qos2_state_ops lws_mqtt_qos2_state_ops_t

lws_mqtt_client_connect_param_t

typedef struct lws_mqtt_client_connect_param_s lws_mqtt_client_connect_param_t

lws_mqtt_publish_param_t

typedef struct lws_mqtt_publish_param_s lws_mqtt_publish_param_t

lws_mqtt_topic_elem_t

typedef struct topic_elem lws_mqtt_topic_elem_t

lws_mqtt_subscribe_param_t

typedef struct lws_mqtt_subscribe_param_s lws_mqtt_subscribe_param_t

Enumeration Type Documentation

lws_mqtt_qos_levels_t

enum lws_mqtt_qos_levels_t

Enumerator
QOS0
QOS1
QOS2
RESERVED_QOS_LEVEL
FAILURE_QOS_LEVEL

Definition at line 73 of file lws-mqtt.h.

             {
        QOS0,
        QOS1,
        QOS2,
        RESERVED_QOS_LEVEL,
        FAILURE_QOS_LEVEL = 0x80

lws_mqtt_control_packet_t

enum lws_mqtt_control_packet_t

Enumerator
LMQCP_RESERVED
LMQCP_CTOS_CONNECT
LMQCP_STOC_CONNACK
LMQCP_PUBLISH
LMQCP_PUBACK
LMQCP_PUBREC
LMQCP_PUBREL
LMQCP_PUBCOMP
LMQCP_CTOS_SUBSCRIBE
LMQCP_STOC_SUBACK
LMQCP_CTOS_UNSUBSCRIBE
LMQCP_STOC_UNSUBACK
LMQCP_CTOS_PINGREQ
LMQCP_STOC_PINGRESP
LMQCP_DISCONNECT
LMQCP_AUTH

Definition at line 182 of file lws-mqtt.h.

             {
        LMQCP_RESERVED,
        LMQCP_CTOS_CONNECT,     /* Connection request */
        LMQCP_STOC_CONNACK,     /* Connection acknowledgment */
        LMQCP_PUBLISH,          /* Publish Message */
        LMQCP_PUBACK,           /* QoS 1:   Publish acknowledgment */
        LMQCP_PUBREC,           /* QoS 2.1: Publish received */
        LMQCP_PUBREL,           /* QoS 2.2: Publish release */
        LMQCP_PUBCOMP,          /* QoS 2.3: Publish complete */
        LMQCP_CTOS_SUBSCRIBE,   /* Subscribe request */
        LMQCP_STOC_SUBACK,      /* Subscribe acknowledgment */
        LMQCP_CTOS_UNSUBSCRIBE, /* Unsubscribe request */
        LMQCP_STOC_UNSUBACK,    /* Unsubscribe acknowledgment */
        LMQCP_CTOS_PINGREQ,     /* PING request */
        LMQCP_STOC_PINGRESP,    /* PONG response */
        LMQCP_DISCONNECT,       /* Disconnect notification */
        LMQCP_AUTH              /* Authentication exchange */

lws_mqtt_connect_flags_t

enum lws_mqtt_connect_flags_t

Enumerator
LMQCFT_USERNAME_NOFREE
LMQCFT_PASSWORD_NOFREE
LMQCFT_CLIENT_ID_NOFREE
LMQCFT_USERNAME
LMQCFT_PASSWORD
LMQCFT_WILL_RETAIN
LMQCFT_WILL_QOS
LMQCFT_WILL_FLAG
LMQCFT_CLEAN_START
LMQCFT_RESERVED
LMQCFT_WILL_QOS_MASK

Definition at line 202 of file lws-mqtt.h.

             {
        LMQCFT_USERNAME_NOFREE                                  = (1 << 10),
        LMQCFT_PASSWORD_NOFREE                                  = (1 << 9),
        LMQCFT_CLIENT_ID_NOFREE                                 = (1 << 8),
        /* only the low 8 are standardized and go out in the protocol */
        LMQCFT_USERNAME                                         = (1 << 7),
        LMQCFT_PASSWORD                                         = (1 << 6),
        LMQCFT_WILL_RETAIN                                      = (1 << 5),
        LMQCFT_WILL_QOS                                         = (1 << 3),
        LMQCFT_WILL_FLAG                                        = (1 << 2),
        LMQCFT_CLEAN_START                                      = (1 << 1),
        LMQCFT_RESERVED                                         = (1 << 0),
 
        LMQCFT_WILL_QOS_MASK                                    = (3 << 3),

lws_mqtt_connack_flags_t

enum lws_mqtt_connack_flags_t

Enumerator
LMQCFT_SESSION_PRESENT

Definition at line 219 of file lws-mqtt.h.

             {
        LMQCFT_SESSION_PRESENT                                  = (1 << 0),

lws_mqtt_reason_t

enum lws_mqtt_reason_t

Enumerator
LMQCP_REASON_SUCCESS
LMQCP_REASON_NORMAL_DISCONNECTION
LMQCP_REASON_GRANTED_QOS0
LMQCP_REASON_GRANTED_QOS1
LMQCP_REASON_GRANTED_QOS2
LMQCP_REASON_DISCONNECT_WILL
LMQCP_REASON_NO_MATCHING_SUBSCRIBER
LMQCP_REASON_NO_SUBSCRIPTION_EXISTED
LMQCP_REASON_CONTINUE_AUTHENTICATION
LMQCP_REASON_RE_AUTHENTICATE
LMQCP_REASON_UNSPECIFIED_ERROR
LMQCP_REASON_MALFORMED_PACKET
LMQCP_REASON_PROTOCOL_ERROR
LMQCP_REASON_IMPLEMENTATION_SPECIFIC_ERROR
LMQCP_REASON_UNSUPPORTED_PROTOCOL
LMQCP_REASON_CLIENT_ID_INVALID
LMQCP_REASON_BAD_CREDENTIALS
LMQCP_REASON_NOT_AUTHORIZED
LMQCP_REASON_SERVER_UNAVAILABLE
LMQCP_REASON_SERVER_BUSY
LMQCP_REASON_BANNED
LMQCP_REASON_SERVER_SHUTTING_DOWN
LMQCP_REASON_BAD_AUTHENTICATION_METHOD
LMQCP_REASON_KEEPALIVE_TIMEOUT
LMQCP_REASON_SESSION_TAKEN_OVER
LMQCP_REASON_TOPIC_FILTER_INVALID
LMQCP_REASON_TOPIC_NAME_INVALID
LMQCP_REASON_PACKET_ID_IN_USE
LMQCP_REASON_PACKET_ID_NOT_FOUND
LMQCP_REASON_MAX_RX_EXCEEDED
LMQCP_REASON_TOPIC_ALIAS_INVALID
LMQCP_REASON_PACKET_TOO_LARGE
LMQCP_REASON_RATELIMIT
LMQCP_REASON_QUOTA_EXCEEDED
LMQCP_REASON_ADMINISTRATIVE_ACTION
LMQCP_REASON_PAYLOAD_FORMAT_INVALID
LMQCP_REASON_RETAIN_NOT_SUPPORTED
LMQCP_REASON_QOS_NOT_SUPPORTED
LMQCP_REASON_USE_ANOTHER_SERVER
LMQCP_REASON_SERVER_MOVED
LMQCP_REASON_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED
LMQCP_REASON_CONNECTION_RATE_EXCEEDED
LMQCP_REASON_MAXIMUM_CONNECT_TIME
LMQCP_REASON_SUBSCRIPTION_IDS_NOT_SUPPORTED
LMQCP_REASON_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED

Definition at line 223 of file lws-mqtt.h.

             {
        LMQCP_REASON_SUCCESS                                    = 0x00,
        LMQCP_REASON_NORMAL_DISCONNECTION                       = 0x00,
        LMQCP_REASON_GRANTED_QOS0                               = 0x00,
        LMQCP_REASON_GRANTED_QOS1                               = 0x01,
        LMQCP_REASON_GRANTED_QOS2                               = 0x02,
        LMQCP_REASON_DISCONNECT_WILL                            = 0x04,
        LMQCP_REASON_NO_MATCHING_SUBSCRIBER                     = 0x10,
        LMQCP_REASON_NO_SUBSCRIPTION_EXISTED                    = 0x11,
        LMQCP_REASON_CONTINUE_AUTHENTICATION                    = 0x18,
        LMQCP_REASON_RE_AUTHENTICATE                            = 0x19,
 
        LMQCP_REASON_UNSPECIFIED_ERROR                          = 0x80,
        LMQCP_REASON_MALFORMED_PACKET                           = 0x81,
        LMQCP_REASON_PROTOCOL_ERROR                             = 0x82,
        LMQCP_REASON_IMPLEMENTATION_SPECIFIC_ERROR              = 0x83,
 
        /* Begin - Error codes for CONNACK */
        LMQCP_REASON_UNSUPPORTED_PROTOCOL                       = 0x84,
        LMQCP_REASON_CLIENT_ID_INVALID                          = 0x85,
        LMQCP_REASON_BAD_CREDENTIALS                            = 0x86,
        LMQCP_REASON_NOT_AUTHORIZED                             = 0x87,
        /* End - Error codes for CONNACK */
 
        LMQCP_REASON_SERVER_UNAVAILABLE                         = 0x88,
        LMQCP_REASON_SERVER_BUSY                                = 0x89,
        LMQCP_REASON_BANNED                                     = 0x8a,
        LMQCP_REASON_SERVER_SHUTTING_DOWN                       = 0x8b,
        LMQCP_REASON_BAD_AUTHENTICATION_METHOD                  = 0x8c,
        LMQCP_REASON_KEEPALIVE_TIMEOUT                          = 0x8d,
        LMQCP_REASON_SESSION_TAKEN_OVER                         = 0x8e,
        LMQCP_REASON_TOPIC_FILTER_INVALID                       = 0x8f,
        LMQCP_REASON_TOPIC_NAME_INVALID                         = 0x90,
        LMQCP_REASON_PACKET_ID_IN_USE                           = 0x91,
        LMQCP_REASON_PACKET_ID_NOT_FOUND                        = 0x92,
        LMQCP_REASON_MAX_RX_EXCEEDED                            = 0x93,
        LMQCP_REASON_TOPIC_ALIAS_INVALID                        = 0x94,
        LMQCP_REASON_PACKET_TOO_LARGE                           = 0x95,
        LMQCP_REASON_RATELIMIT                                  = 0x96,
        LMQCP_REASON_QUOTA_EXCEEDED                             = 0x97,
        LMQCP_REASON_ADMINISTRATIVE_ACTION                      = 0x98,
        LMQCP_REASON_PAYLOAD_FORMAT_INVALID                     = 0x99,
        LMQCP_REASON_RETAIN_NOT_SUPPORTED                       = 0x9a,
        LMQCP_REASON_QOS_NOT_SUPPORTED                          = 0x9b,
        LMQCP_REASON_USE_ANOTHER_SERVER                         = 0x9c,
        LMQCP_REASON_SERVER_MOVED                               = 0x9d,
        LMQCP_REASON_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED         = 0x9e,
        LMQCP_REASON_CONNECTION_RATE_EXCEEDED                   = 0x9f,
        LMQCP_REASON_MAXIMUM_CONNECT_TIME                       = 0xa0,
        LMQCP_REASON_SUBSCRIPTION_IDS_NOT_SUPPORTED             = 0xa1,
        LMQCP_REASON_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED       = 0xa2,

lws_mqtt_property

enum lws_mqtt_property

Enumerator
LMQPROP_INVALID
LMQPROP_PAYLOAD_FORMAT_INDICATOR
LMQPROP_MESSAGE_EXPIRY_INTERVAL
LMQPROP_CONTENT_TYPE
LMQPROP_RESPONSE_TOPIC
LMQPROP_CORRELATION_DATA
LMQPROP_SUBSCRIPTION_IDENTIFIER
LMQPROP_SESSION_EXPIRY_INTERVAL
LMQPROP_ASSIGNED_CLIENT_IDENTIFIER
LMQPROP_SERVER_KEEP_ALIVE
LMQPROP_AUTHENTICATION_METHOD
LMQPROP_AUTHENTICATION_DATA
LMQPROP_REQUEST_PROBLEM_INFORMATION
LMQPROP_WILL_DELAY_INTERVAL
LMQPROP_REQUEST_RESPONSE_INFORMATION
LMQPROP_RESPONSE_INFORMATION
LMQPROP_SERVER_REFERENCE
LMQPROP_REASON_STRING
LMQPROP_RECEIVE_MAXIMUM
LMQPROP_TOPIC_ALIAS_MAXIMUM
LMQPROP_TOPIC_ALIAS
LMQPROP_MAXIMUM_QOS
LMQPROP_RETAIN_AVAILABLE
LMQPROP_USER_PROPERTY
LMQPROP_MAXIMUM_PACKET_SIZE
LMQPROP_WILDCARD_SUBSCRIPTION_AVAIL
LMQPROP_SUBSCRIPTION_IDENTIFIER_AVAIL
LMQPROP_SHARED_SUBSCRIPTION_AVAIL

Definition at line 276 of file lws-mqtt.h.

             {
        LMQPROP_INVALID,
        LMQPROP_PAYLOAD_FORMAT_INDICATOR                        = 0x01,
        LMQPROP_MESSAGE_EXPIRY_INTERVAL                         = 0x02,
        LMQPROP_CONTENT_TYPE                                    = 0x03,
        LMQPROP_RESPONSE_TOPIC                                  = 0x08,
        LMQPROP_CORRELATION_DATA                                = 0x09,
        LMQPROP_SUBSCRIPTION_IDENTIFIER                         = 0x0b,
        LMQPROP_SESSION_EXPIRY_INTERVAL                         = 0x11,
        LMQPROP_ASSIGNED_CLIENT_IDENTIFIER                      = 0x12,
        LMQPROP_SERVER_KEEP_ALIVE                               = 0x13,
        LMQPROP_AUTHENTICATION_METHOD                           = 0x15,
        LMQPROP_AUTHENTICATION_DATA                             = 0x16,
        LMQPROP_REQUEST_PROBLEM_INFORMATION                     = 0x17,
        LMQPROP_WILL_DELAY_INTERVAL                             = 0x18,
        LMQPROP_REQUEST_RESPONSE_INFORMATION                    = 0x19,
        LMQPROP_RESPONSE_INFORMATION                            = 0x1a,
        LMQPROP_SERVER_REFERENCE                                = 0x1c,
        LMQPROP_REASON_STRING                                   = 0x1f,
        LMQPROP_RECEIVE_MAXIMUM                                 = 0x21,
        LMQPROP_TOPIC_ALIAS_MAXIMUM                             = 0x22,
        LMQPROP_TOPIC_ALIAS                                     = 0x23,
        LMQPROP_MAXIMUM_QOS                                     = 0x24,
        LMQPROP_RETAIN_AVAILABLE                                = 0x25,
        LMQPROP_USER_PROPERTY                                   = 0x26,
        LMQPROP_MAXIMUM_PACKET_SIZE                             = 0x27,
        LMQPROP_WILDCARD_SUBSCRIPTION_AVAIL                     = 0x28,
        LMQPROP_SUBSCRIPTION_IDENTIFIER_AVAIL                   = 0x29,
        LMQPROP_SHARED_SUBSCRIPTION_AVAIL                       = 0x2a

Function Documentation

lws_mqtt_bindata_cmp()

LWS_VISIBLE LWS_EXTERN int lws_mqtt_bindata_cmp	(	const lws_mqtt_str_t *	bd1,
		const lws_mqtt_str_t *	bd2 )

References LWS_EXTERN, and LWS_VISIBLE.

lws_mqtt_str_init()

LWS_VISIBLE LWS_EXTERN void lws_mqtt_str_init	(	lws_mqtt_str_t *	s,
		uint8_t *	buf,
		uint16_t	lim,
		char	nf )

References LWS_EXTERN, and LWS_VISIBLE.

lws_mqtt_str_create()

LWS_VISIBLE LWS_EXTERN lws_mqtt_str_t * lws_mqtt_str_create

(

uint16_t

lim

)

References LWS_EXTERN, and LWS_VISIBLE.

lws_mqtt_str_create_init()

LWS_VISIBLE LWS_EXTERN lws_mqtt_str_t * lws_mqtt_str_create_init	(	uint8_t *	buf,
		uint16_t	len,
		uint16_t	lim )

References LWS_EXTERN, and LWS_VISIBLE.

lws_mqtt_str_create_cstr_dup()

LWS_VISIBLE LWS_EXTERN lws_mqtt_str_t * lws_mqtt_str_create_cstr_dup	(	const char *	buf,
		uint16_t	lim )

References LWS_EXTERN, and LWS_VISIBLE.

lws_mqtt_str_next()

LWS_VISIBLE LWS_EXTERN uint8_t * lws_mqtt_str_next	(	lws_mqtt_str_t *	s,
		uint16_t *	budget )

References LWS_EXTERN, and LWS_VISIBLE.

lws_mqtt_str_advance()

LWS_VISIBLE LWS_EXTERN int lws_mqtt_str_advance	(	lws_mqtt_str_t *	s,
		int	n )

References LWS_EXTERN, and LWS_VISIBLE.

lws_mqtt_str_free()

LWS_VISIBLE LWS_EXTERN void lws_mqtt_str_free

(

lws_mqtt_str_t **

s

)

References LWS_EXTERN, and LWS_VISIBLE.

lws_mqtt_client_send_publish()

LWS_VISIBLE LWS_EXTERN int lws_mqtt_client_send_publish	(	struct lws *	wsi,
		lws_mqtt_publish_param_t *	pub,
		const void *	buf,
		uint32_t	len,
		int	final )

lws_mqtt_client_send_publish() - lws_write a publish packet

Parameters

wsi	the mqtt child wsi
pub	additional information on what we're publishing
buf	payload to send, with LWS_PRE bytes valid before it as for lws_write()
len	length of data in buf
final	flag indicating this is the last part

Issues part of, or the whole of, a PUBLISH frame. The first part of the frame contains the header, and uses the .qos and .payload_len parts of pub since MQTT requires the frame to specify the PUBLISH message length at the start. The len paramter may be less than pub.payload_len, in which case subsequent calls with more payload are needed to complete the frame.

Although the connection is stuck waiting for the remainder, in that it can't issue any other frames until the current one is completed, lws returns to the event loop normally and can continue the calls with additional payload even for huge frames as the data becomes available, consistent with timeout needs and latency to start any new frame (even, eg, related to ping / pong).

If you're sending large frames, the OS will typically not allow the data to be sent all at once to kernel side. So you should ideally cut the payload up into 1 or 2- mtu sized chunks and send that.

Final should be set when you're calling with the last part of the payload.

While a PUBLISH is going out in parts, nothing else can be sent on the connection, including the acks lws owes the broker for what it receives. lws holds a limited number of those, and when they fill up it stops reading the connection until it can write them, ie, until this PUBLISH is finished. So finishing a PUBLISH sent in parts must not wait for anything received on the same connection, or it may wait forever.

A QoS0 PUBLISH has no PUBACK, lws acknowledges it locally with LWS_CALLBACK_MQTT_ACK once the last part is sent. Like a real PUBACK for QoS1, that comes afterwards from the event loop, never from inside this call.

A stream has at most one operation awaiting the broker's ack: a QoS1 or QoS2 PUBLISH until its LWS_CALLBACK_MQTT_ACK (for QoS2, that comes at the PUBREC; lws completes the exchange itself), or a SUBSCRIBE or UNSUBSCRIBE until its SUBSCRIBED or UNSUBSCRIBED. Starting a QoS1 or QoS2 PUBLISH while one is awaiting its ack fails. After LWS_CALLBACK_MQTT_RESEND, the PUBLISH may be sent again with pub .dup set, which goes with the packet id it went with before, or the stream may go on to something else instead. Use more streams on the connection for more operations at once.

References LWS_EXTERN, and LWS_VISIBLE.

lws_mqtt_client_send_subcribe()

LWS_VISIBLE LWS_EXTERN int lws_mqtt_client_send_subcribe	(	struct lws *	wsi,
		lws_mqtt_subscribe_param_t *	sub )

lws_mqtt_client_send_subcribe() - lws_write a subscribe packet

Parameters

wsi	the mqtt child wsi
sub	which topic(s) we want to subscribe to

For topics other child streams have not already subscribed to, send a packet to the server asking to subscribe to them. If all topics listed are already subscribed to be the shared network connection, just trigger the LWS_CALLBACK_MQTT_SUBSCRIBED callback as if a SUBACK had come: like a real SUBACK, it comes afterwards from the event loop, not from inside this call.

It fails if the stream already has an operation awaiting the broker's ack, see lws_mqtt_client_send_publish().

sub doesn't need to exist after the return from this function.

References LWS_EXTERN, and LWS_VISIBLE.

lws_mqtt_client_send_unsubcribe()

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_mqtt_client_send_unsubcribe	(	struct lws *	wsi,
		const lws_mqtt_subscribe_param_t *	unsub )

lws_mqtt_client_send_unsubcribe() - lws_write a unsubscribe packet

Parameters

wsi	the mqtt child wsi
unsub	which topic(s) we want to unsubscribe from

For topics other child streams are not subscribed to, send a packet to the server asking to unsubscribe from them. If all topics listed are already subscribed by other child streams on the shared network connection, just trigger the LWS_CALLBACK_MQTT_UNSUBSCRIBED callback as if a UNSUBACK had come: like a real UNSUBACK, it comes afterwards from the event loop, not from inside this call.

It fails if the stream already has an operation awaiting the broker's ack, see lws_mqtt_client_send_publish().

unsub doesn't need to exist after the return from this function.

References LWS_EXTERN, LWS_VISIBLE, and LWS_WARN_UNUSED_RESULT.

lws_mqtt_client_qos2_rx_add()

LWS_VISIBLE LWS_EXTERN int lws_mqtt_client_qos2_rx_add	(	struct lws *	wsi,
		uint16_t	pkt_id )

lws_mqtt_client_qos2_rx_add() - inject a saved QoS2 packet ID into the rx list

Parameters

wsi	the mqtt child wsi
pkt_id	the packet ID to inject

This allows the application to repopulate the unacknowledged QoS2 receives from persistent storage when a session is resumed.

References LWS_EXTERN, and LWS_VISIBLE.