--- libaitmqtt/inc/aitmqtt.h 2012/01/26 14:57:57 1.1.1.1.2.2 +++ libaitmqtt/inc/aitmqtt.h 2013/05/30 09:18:33 1.3 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitmqtt.h,v 1.1.1.1.2.2 2012/01/26 14:57:57 misho Exp $ +* $Id: aitmqtt.h,v 1.3 2013/05/30 09:18:33 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, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -47,6 +47,15 @@ SUCH DAMAGE. #define __AITMQTT_H +#define MAX_CONNID 24 +#define MAX_CRED 13 +#define MQTTMSG_MAX 65529 +#define MQTT_DATA_MAX 268435455 + +#define MQTT_PROTO_VER 3 +#define MQTT_KEEPALIVE 10 +#define MQTT_DEFAULT_MSGID 0xDEBA + /* FIXED HEADER */ struct mqtthdr { @@ -62,6 +71,7 @@ struct mqtthdr { 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) +#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 */ @@ -95,6 +105,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, @@ -138,10 +151,6 @@ typedef struct { unsigned short msg_len; } mqtt_msg_t; -/* MQTT hooks callback */ - -typedef void *(*mqtt_cb_t)(void *); - /* MQTT structures */ typedef union { @@ -187,9 +196,9 @@ typedef struct { // ------------------------------------------------------- // 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(); // ------------------------------------------------------- @@ -199,7 +208,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 * @@ -207,7 +216,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 * @@ -215,7 +224,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 @@ -229,6 +245,15 @@ inline int mqtt_msgRealloc(mqtt_msg_t * __restrict msg */ int mqtt_expandTopic(const char *csInput, char * __restrict psRegEx, int regexLen, unsigned char BOL, unsigned char EOL); +/* + * mqtt_sqlTopic() - Expanding topic to SQL search string + * + * @csInput = Input topic + * @psSQL = Output to SQL search string + * @sqlLen = Length of psSQL + * return: -1 error, 0 changed bytes + */ +int mqtt_sqlTopic(const char *csInput, char * __restrict psSQL, int sqlLen); /* * mqtt_encodeLen() Encode number to MQTT length field @@ -236,7 +261,7 @@ int mqtt_expandTopic(const char *csInput, char * __res * @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 * @@ -244,38 +269,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 * @@ -283,7 +316,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 ***/ @@ -293,7 +334,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 @@ -360,7 +401,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 * @@ -368,7 +409,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 * @@ -376,7 +417,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 * @@ -384,7 +425,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 @@ -489,12 +530,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 * @@ -530,9 +570,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 @@ -549,9 +589,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