--- libaitmqtt/inc/aitmqtt.h 2012/02/04 10:40:01 1.1.1.1.2.6 +++ libaitmqtt/inc/aitmqtt.h 2022/09/12 23:15:37 1.3.4.5 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitmqtt.h,v 1.1.1.1.2.6 2012/02/04 10:40:01 misho Exp $ +* $Id: aitmqtt.h,v 1.3.4.5 2022/09/12 23:15:37 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -12,7 +12,7 @@ terms: All of the documentation and software included in the ELWIX and AITNET Releases is copyrighted by ELWIX - Sofia/Bulgaria -Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 +Copyright 2004 - 2022 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -49,10 +49,12 @@ SUCH DAMAGE. #define MAX_CONNID 24 #define MAX_CRED 13 -#define MQTTMSG_MAX 65529 +#define MQTTMSG_MAX 65535 +#define MQTTMSG_BIN_MAX 65535 #define MQTT_DATA_MAX 268435455 #define MQTT_PROTO_VER 3 +#define MQTT_PROTO_DEFVER 5 #define MQTT_KEEPALIVE 10 #define MQTT_DEFAULT_MSGID 0xDEBA @@ -69,26 +71,29 @@ struct mqtthdr { unsigned char val; } mqtt_msg; unsigned char mqtt_len[1]; /* may be grow to 4 bytes */ -} __packed; -#define MQTTHDR_MSGINIT(x) (assert((x)), (x)->mqtt_msg.val ^= (x)->mqtt_msg.val) +} __attribute__((packed)); +#define MQTTHDR_MSGINIT(x) (assert((x)), (x)->mqtt_msg.val ^= (x)->mqtt_msg.val, *mqtt_len = 0) +#define MQTTHDR_DATA_SIZEOF(x) (assert((x)), mqtt_decodeLen((x)->mqtt_len, NULL)) #define MQTT_TYPE_UNKNOWN 0 /* reserved */ -#define MQTT_TYPE_CONNECT 1 /* client request to connect to server */ -#define MQTT_TYPE_CONNACK 2 /* connect acknowledgment */ -#define MQTT_TYPE_PUBLISH 3 /* publish message */ -#define MQTT_TYPE_PUBACK 4 /* publish acknowledgment */ -#define MQTT_TYPE_PUBREC 5 /* publish received (assured delivery part 1) */ -#define MQTT_TYPE_PUBREL 6 /* publish release (assured delivery part 2) */ -#define MQTT_TYPE_PUBCOMP 7 /* publish complete (assured delivery part 3) */ -#define MQTT_TYPE_SUBSCRIBE 8 /* client subscribe request */ -#define MQTT_TYPE_SUBACK 9 /* subscribe acknowledgment */ -#define MQTT_TYPE_UNSUBSCRIBE 10 /* client unsubscribe request */ -#define MQTT_TYPE_UNSUBACK 11 /* unsubscribe acknowledgment */ -#define MQTT_TYPE_PINGREQ 12 /* PING request */ -#define MQTT_TYPE_PINGRESP 13 /* PING response */ -#define MQTT_TYPE_DISCONNECT 14 /* client is disconnecting */ -#define MQTT_TYPE_MAX 15 /* reserved */ +#define MQTT_TYPE_CONNECT 1 /* client request to connect to server (CLI) */ +#define MQTT_TYPE_CONNACK 2 /* connect acknowledgment (SRV) [ret_no_data] */ +#define MQTT_TYPE_PUBLISH 3 /* publish message [ret_is_optional] */ +#define MQTT_TYPE_PUBACK 4 /* publish acknowledgment [ret_no_data] */ +#define MQTT_TYPE_PUBREC 5 /* publish received (assured delivery part 1) [ret_no_data] */ +#define MQTT_TYPE_PUBREL 6 /* publish release (assured delivery part 2) [ret_no_data] */ +#define MQTT_TYPE_PUBCOMP 7 /* publish complete (assured delivery part 3) [ret_no_data] */ +#define MQTT_TYPE_SUBSCRIBE 8 /* client subscribe request (CLI) */ +#define MQTT_TYPE_SUBACK 9 /* subscribe acknowledgment (SRV) */ +#define MQTT_TYPE_UNSUBSCRIBE 10 /* client unsubscribe request (CLI) */ +#define MQTT_TYPE_UNSUBACK 11 /* unsubscribe acknowledgment (SRV) */ +#define MQTT_TYPE_PINGREQ 12 /* PING request (CLI) [ret_no_data] */ +#define MQTT_TYPE_PINGRESP 13 /* PING response (SRV) [ret_no_data] */ +#define MQTT_TYPE_DISCONNECT 14 /* client is disconnecting [ret_no_data] */ +#define MQTT_TYPE_AUTH 15 /* authentication exchange [ret_no_data] */ +#define MQTT_TYPE_MAX 15 + #define MQTT_FLAG_DUP 1 /* This flag is set when the client or server attempts to re-deliver a PUBLISH, PUBREL, SUBSCRIBE or UNSUBSCRIBE message. This applies to messages where the value of QoS is greater than @@ -104,6 +109,9 @@ struct mqtthdr { #define MQTT_QOS_EXACTLY 2 /* Exactly once, Assured delivery, =1 */ #define MQTT_QOS_RESERVED 3 /* reserved */ +#define MQTT_QOS_DENY 0 /* Not granted QoS for SUBACK */ +#define MQTT_QOS_PASS 2 /* Granted QoS for SUBACK */ + #define MQTT_FLAG_RETAIN 1 /* This flag is only used on PUBLISH messages. When a client sends a PUBLISH to a server, @@ -139,7 +147,55 @@ struct mqtthdr { #define MQTT_RETCODE_REFUSE_USERPASS 4 #define MQTT_RETCODE_DENIED 5 +/* REASON CODES */ +#define MQTT_REASON_OK 0x0 /* CONNACK, PUBACK, PUBREC, PUBREL, PUBCOMP, UNSUBACK, AUTH, DISCONNECT, SUBACK */ +#define MQTT_REASON_QOS1 0x1 /* SUBACK */ +#define MQTT_REASON_QOS2 0x2 /* SUBACK */ +#define MQTT_REASON_DWILL 0x4 /* DISCONNECT */ +#define MQTT_REASON_NOMATCH 0x10 /* PUBACK, PUBREC */ +#define MQTT_REASON_NOSUBEXIST 0x11 /* UNSUBACK */ +#define MQTT_REASON_CONTAUTH 0x18 /* AUTH */ +#define MQTT_REASON_REAUTH 0x19 /* AUTH */ + +/* REASON ERROR CODES */ + +#define MQTT_REASON_ERROR 0x80 /* CONNACK, PUBACK, PUBREC, SUBACK, UNSUBACK, DISCONNECT */ +#define MQTT_REASON_MALFORMPKT 0x81 /* CONNACK, DISCONNECT */ +#define MQTT_REASON_PROTOERR 0x82 /* CONNACK, DISCONNECT */ +#define MQTT_REASON_IMPLSPECERR 0x83 /* CONNACK, PUBACK, PUBREC, SUBACK, UNSUBACK, DISCONNECT */ +#define MQTT_REASON_UNSUPVERPROTO 0x84 /* CONNACK */ +#define MQTT_REASON_CLINOVALID 0x85 /* CONNACK */ +#define MQTT_REASON_BADUSERPASS 0x86 /* CONNACK */ +#define MQTT_REASON_NOAUTH 0x87 /* CONNACK, PUBACK, PUBREC, SUBACK, UNSUBACK, DISCONNECT */ +#define MQTT_REASON_SRVUNAVAIL 0x88 /* CONNACK */ +#define MQTT_REASON_SRVBUSY 0x89 /* CONNACK, DISCONNECT */ +#define MQTT_REASON_BANNED 0x8A /* CONNACK */ +#define MQTT_REASON_SRVSHUTDOWN 0x8B /* DISCONNECT */ +#define MQTT_REASON_BADAUTHMETHOD 0x8C /* CONNACK, DISCONNECT */ +#define MQTT_REASON_KEEPALIVETO 0x8D /* DISCONNECT */ +#define MQTT_REASON_SESTAKEOVER 0x8E /* DISCONNECT */ +#define MQTT_REASON_TOPICFLTINVAL 0x8F /* SUBACK, UNSUBACK, DISCONNECT */ +#define MQTT_REASON_TOPICNAMEINV 0x90 /* CONNACK, PUBACK, PUBREC, DISCONNECT */ +#define MQTT_REASON_PKTIDINUSE 0x91 /* PUBACK, PUBREC, SUBACK, UNSUBACK */ +#define MQTT_REASON_PKTIDNOTFOUND 0x92 /* PUBREL, PUBCOMP */ +#define MQTT_REASON_RCVMAXEXCEED 0x93 /* DISCONNECT */ +#define MQTT_REASON_TOPICALIASINV 0x94 /* DISCONNECT */ +#define MQTT_REASON_PKTTOOLARGE 0x95 /* CONNACK, DISCONNECT */ +#define MQTT_REASON_MSGRATETOHIGH 0x96 /* DISCONNECT */ +#define MQTT_REASON_QUOTAEXCEED 0x97 /* CONNACK, PUBACK, PUBREC, SUBACK, DISCONNECT */ +#define MQTT_REASON_ADMINACTION 0x98 /* DISCONNECT */ +#define MQTT_REASON_PAYLOADFMTINV 0x99 /* CONNACK, PUBACK, PUBREC, DISCONNECT */ +#define MQTT_REASON_RETAINNOTSUP 0x9A /* CONNACK, DISCONNECT */ +#define MQTT_REASON_QOSNOTSUP 0x9B /* CONNACK, DISCONNECT */ +#define MQTT_REASON_USENEXTSRV 0x9C /* CONNACK, DISCONNECT */ +#define MQTT_REASON_SRVMOVED 0x9D /* CONNACK, DISCONNECT */ +#define MQTT_REASON_SHARSUBNOTSUP 0x9E /* SUBACK, DISCONNECT */ +#define MQTT_REASON_CONRATEEXCEED 0x9F /* CONNACK, DISCONNECT */ +#define MQTT_REASON_MAXCONNTIME 0xA0 /* DISCONNECT */ +#define MQTT_REASON_SUBIDNOTSUP 0xA1 /* SUBACK, DISCONNECT */ +#define MQTT_RESON_WILDSUBNOTSUP 0xA2 /* SUBACK, DISCONNECT */ + /* MQTT Message buffer */ typedef struct { @@ -166,7 +222,7 @@ typedef struct { typedef struct { mqtt_len_t var_sb; unsigned char var_data[0]; -} __packed mqtthdr_var_t; +} __attribute__((packed)) mqtthdr_var_t; #define MQTTHDR_VAR_SIZEOF(x) (assert((x)), sizeof(mqtt_len_t) + ntohs((x)->var_sb.val)) typedef unsigned char mqtthdr_protover_t; @@ -182,19 +238,19 @@ typedef union { username:1; }; unsigned char flags; -} __packed mqtthdr_connflgs_t; +} __attribute__((packed)) mqtthdr_connflgs_t; typedef struct { unsigned char reserved; unsigned char retcode; -} __packed mqtthdr_connack_t; +} __attribute__((packed)) mqtthdr_connack_t; // ------------------------------------------------------- // mqtt_GetErrno() Get error code of last operation -inline int mqtt_GetErrno(); +int mqtt_GetErrno(); // mqtt_GetError() Get error text of last operation -inline const char *mqtt_GetError(); +const char *mqtt_GetError(); // ------------------------------------------------------- @@ -204,7 +260,7 @@ inline const char *mqtt_GetError(); * @len = >0 Allocate buffer with length * return: NULL error or Message, after use must call mqtt_msgFree() with all!=0 */ -inline mqtt_msg_t *mqtt_msgAlloc(unsigned short len); +mqtt_msg_t *mqtt_msgAlloc(unsigned short len); /* * mqtt_msgFree() Free MQTT message * @@ -212,7 +268,7 @@ inline mqtt_msg_t *mqtt_msgAlloc(unsigned short len); * @all = !=0 Destroy entire message, if MQTT Message allocated with mqtt_msgAlloc() * return: none */ -inline void mqtt_msgFree(mqtt_msg_t ** __restrict msg, int all); +void mqtt_msgFree(mqtt_msg_t ** __restrict msg, int all); /* * mqtt_msgRealloc() Reallocate MQTT message buffer * @@ -220,7 +276,14 @@ inline void mqtt_msgFree(mqtt_msg_t ** __restrict msg, * @len = new length * return: -1 error or >-1 old buffer length */ -inline int mqtt_msgRealloc(mqtt_msg_t * __restrict msg, unsigned short len); +int mqtt_msgRealloc(mqtt_msg_t * __restrict msg, unsigned short len); +/* + * mqtt_msgDup() - Duplicate message buffer + * + * @msg = Message + * return: NULL error or !=NULL duplicated message, after use must call mqtt_msgFree() with all!=0 + */ +mqtt_msg_t *mqtt_msgDup(mqtt_msg_t * __restrict msg); /* * mqtt_expandTopic() - Expanding topic to regular expression @@ -250,7 +313,7 @@ int mqtt_sqlTopic(const char *csInput, char * __restri * @num = number for encode * return: -1 error or >-1 length */ -inline unsigned int mqtt_encodeLen(unsigned int num); +unsigned int mqtt_encodeLen(unsigned int num); /* * mqtt_decodeLen() Decode length from MQTT packet * @@ -258,38 +321,46 @@ inline unsigned int mqtt_encodeLen(unsigned int num); * @n = sizeof bytes, if !=NULL * return: -1 error, >-1 length of message */ -inline unsigned int mqtt_decodeLen(void * __restrict len, int * __restrict n); +unsigned int mqtt_decodeLen(void * __restrict len, int * __restrict n); /* * mqtt_sizeLen Return sizeof len field * * @len = length * return: -1 error, >-1 sizeof len in bytes */ -inline char mqtt_sizeLen(unsigned int len); +char mqtt_sizeLen(unsigned int len); /* - * mqtt_str2sub Create MQTT subscribe variable from string(s) + * mqtt_pktLen() - Get total packet length * - * @csStr = strings - * @strnum = number of strings elements + * @hdr = MQTT packet header + * return: packet length + */ +unsigned int mqtt_pktLen(struct mqtthdr * __restrict hdr); +/* + * mqtt_str2subs Create MQTT subscribe variable from string(s) + * + * @csStr = null terminated string array + * @strnum = copy at most number of strings elements * @qoses = QoS elements applied to subscribe variable, * count of elements must be equal with csStr elements * return: NULL error or != subscribe variables array, must be free after use with mqtt_freeSub() */ -inline mqtt_subscr_t *mqtt_str2sub(const char **csStr, unsigned short strnum, unsigned char *qoses); +mqtt_subscr_t *mqtt_str2subs(const char **csStr, unsigned short strnum, + unsigned char *qoses); /* * mqtt_subFree() Free array from subscribe variables * * @subs = Subscribe variables * return: none */ -inline void mqtt_subFree(mqtt_subscr_t ** __restrict subs); +void mqtt_subFree(mqtt_subscr_t ** __restrict subs); /* * mqtt_subAlloc() Create array from subscribe variables * * @num = Number of elements * return: NULL error or subscribe array, after use must call mqtt_subFree() */ -inline mqtt_subscr_t *mqtt_subAlloc(unsigned short num); +mqtt_subscr_t *mqtt_subAlloc(unsigned short num); /* * mqtt_subRealloc() Reallocate array from subscribe variables * @@ -297,7 +368,15 @@ inline mqtt_subscr_t *mqtt_subAlloc(unsigned short num * @num = Number of elements * return: NULL error or subscribe array, after use must call mqtt_subFree() */ -inline mqtt_subscr_t *mqtt_subRealloc(mqtt_subscr_t * __restrict subs, unsigned short num); +mqtt_subscr_t *mqtt_subRealloc(mqtt_subscr_t ** __restrict subs, unsigned short num); +/* + * mqtt_subCopy() - Copy subscription structure to another one + * + * @dst = destination subscription + * @src = source subscription + * return: =NULL error or !=NULL successful copied a structure + */ +mqtt_subscr_t *mqtt_subCopy(mqtt_subscr_t * __restrict dst, mqtt_subscr_t * __restrict src); /*** SENDER FUNCTIONS ***/ @@ -307,7 +386,7 @@ inline mqtt_subscr_t *mqtt_subRealloc(mqtt_subscr_t * * * @buf = Message buffer * @csConnID = ConnectID - * @kasec = Keep alive timeout + * @kasec = Keep alive timeout, if =0 default timeout for MQTT * @csUser = Username if !=NULL * @csPass = Password for Username, only if csUser is set * @csWillTopic = Will Topic if !=NULL Will Flags set into message @@ -374,7 +453,7 @@ int mqtt_msgPUBLISH(mqtt_msg_t * __restrict buf, const * @msgID = MessageID * return: -1 error or >-1 message size for send */ -inline int mqtt_msgPUBACK(mqtt_msg_t * __restrict buf, unsigned short msgID); +int mqtt_msgPUBACK(mqtt_msg_t * __restrict buf, unsigned short msgID); /* * mqtt_msgPUBREC() Create PUBREC message * @@ -382,7 +461,7 @@ inline int mqtt_msgPUBACK(mqtt_msg_t * __restrict buf, * @msgID = MessageID * return: -1 error or >-1 message size for send */ -inline int mqtt_msgPUBREC(mqtt_msg_t * __restrict buf, unsigned short msgID); +int mqtt_msgPUBREC(mqtt_msg_t * __restrict buf, unsigned short msgID); /* * mqtt_msgPUBREL() Create PUBREL message * @@ -390,7 +469,7 @@ inline int mqtt_msgPUBREC(mqtt_msg_t * __restrict buf, * @msgID = MessageID * return: -1 error or >-1 message size for send */ -inline int mqtt_msgPUBREL(mqtt_msg_t * __restrict buf, unsigned short msgID); +int mqtt_msgPUBREL(mqtt_msg_t * __restrict buf, unsigned short msgID); /* * mqtt_msgPUBCOMP() Create PUBCOMP message * @@ -398,7 +477,7 @@ inline int mqtt_msgPUBREL(mqtt_msg_t * __restrict buf, * @msgID = MessageID * return: -1 error or >-1 message size for send */ -inline int mqtt_msgPUBCOMP(mqtt_msg_t * __restrict buf, unsigned short msgID); +int mqtt_msgPUBCOMP(mqtt_msg_t * __restrict buf, unsigned short msgID); /* * mqtt_msgSUBSCRIBE() Create SUBSCRIBE message @@ -503,12 +582,11 @@ int mqtt_readPINGRESP(mqtt_msg_t * __restrict buf); * @psTopic = Topic * @topicLen = Topic length * @msgID = MessageID - * @pData = Data buffer - * @datLen = Data buffer length, if *datLen == 0 allocate memory for pData - * return: NULL error or !=NULL MQTT fixed header + * @pData = Data buffer, may be NULL + * return: -1 error or !=-1 allocated data buffer length */ -struct mqtthdr *mqtt_readPUBLISH(mqtt_msg_t * __restrict buf, char * __restrict psTopic, - int topicLen, unsigned short *msgID, void * __restrict pData, int *datLen); +int mqtt_readPUBLISH(mqtt_msg_t * __restrict buf, char * __restrict psTopic, + int topicLen, unsigned short *msgID, void ** __restrict pData); /* * mqtt_readPUBACK() Read PUBACK message * @@ -544,9 +622,9 @@ unsigned short mqtt_readPUBCOMP(mqtt_msg_t * __restric * @buf = Message buffer * @msgID = MessageID * @subscr = Subscriptions, must be free after use with mqtt_subFree() - * return: NULL error or !=NULL MQTT fixed header + * return: -1 error or >-1 elements into subscr */ -struct mqtthdr *mqtt_readSUBSCRIBE(mqtt_msg_t * __restrict buf, unsigned short *msgID, +int mqtt_readSUBSCRIBE(mqtt_msg_t * __restrict buf, unsigned short *msgID, mqtt_subscr_t **subscr); /* * mqtt_readSUBACK() Read SUBACK message @@ -563,9 +641,9 @@ int mqtt_readSUBACK(mqtt_msg_t * __restrict buf, unsig * @buf = Message buffer * @msgID = MessageID * @subscr = Subscriptions, must be free after use with mqtt_subFree() - * return: NULL error or !=NULL MQTT fixed header + * return: -1 error or >-1 elements into subscr */ -struct mqtthdr *mqtt_readUNSUBSCRIBE(mqtt_msg_t * __restrict buf, unsigned short *msgID, +int mqtt_readUNSUBSCRIBE(mqtt_msg_t * __restrict buf, unsigned short *msgID, mqtt_subscr_t **subscr); /* * mqtt_readUNSUBACK() Read UNSUBACK message