--- mqtt/inc/Attic/aitmqtt.h 2011/11/22 10:33:39 1.1.1.1.2.13 +++ mqtt/inc/Attic/aitmqtt.h 2011/12/05 14:11:47 1.1.1.1.2.24 @@ -2,22 +2,21 @@ #define __AITMQTT_H -#define MQTT_DATA_MAX 268435455 -#define MQTT_CONN_STR "MQIsdp" -#define MQTT_PROTO_VER 3 -#define MQTT_KEEPALIVE 10 - /* FIXED HEADER */ struct mqtthdr { - struct { - unsigned char retain:1, - qos:2, - dup:1, - type:4; + union { + struct { + unsigned char retain:1, + qos:2, + dup:1, + type:4; + }; + unsigned char val; } mqtt_msg; - unsigned char mqtt_len[1]; /* may be grow to 4 bytes */ + 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 MQTT_TYPE_UNKNOWN 0 /* reserved */ #define MQTT_TYPE_CONNECT 1 /* client request to connect to server */ @@ -34,7 +33,7 @@ struct mqtthdr { #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_RESERVED 15 /* reserved */ +#define MQTT_TYPE_MAX 15 /* reserved */ #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. @@ -96,9 +95,9 @@ typedef union { } mqtt_v_t; typedef struct { - mqtt_v_t sub_sb; - char *sub_data; - unsigned char sub_qos; + unsigned char sub_ret; + struct __sbuf sub_topic; + struct __sbuf sub_value; } mqtt_subscr_t; typedef struct { @@ -132,7 +131,11 @@ typedef struct { unsigned short msg_len; } mqtt_msg_t; +/* MQTT dispatcher callbacks */ +typedef int (*mqtt_cb_t)(void *); + + // ------------------------------------------------------- // mqtt_GetErrno() Get error code of last operation inline int mqtt_GetErrno(); @@ -143,12 +146,14 @@ inline const char *mqtt_GetError(); /* * mqtt_msgAlloc() Allocate memory for MQTT Message + * * @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_msgFree() Free MQTT message + * * @msg = Message buffer * @all = !=0 Destroy entire message, if MQTT Message allocated with mqtt_msgAlloc() * return: none @@ -156,6 +161,7 @@ inline mqtt_msg_t *mqtt_msgAlloc(unsigned short len); inline void mqtt_msgFree(mqtt_msg_t ** __restrict msg, int all); /* * mqtt_msgRealloc() Reallocate MQTT message buffer + * * @msg = MQTT message * @len = new length * return: -1 error or >-1 old buffer length @@ -164,25 +170,29 @@ inline int mqtt_msgRealloc(mqtt_msg_t * __restrict msg /* * mqtt_encodeLen() Encode number to MQTT length field + * * @num = number for encode * return: -1 error or >-1 length */ inline unsigned int mqtt_encodeLen(unsigned int num); /* * mqtt_decodeLen() Decode length from MQTT packet - * @len = length + * + * @len = length from MQTT header * @n = sizeof bytes, if !=NULL * return: -1 error, >-1 length of message */ -inline unsigned int mqtt_decodeLen(unsigned int len, char *n); +inline 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); /* * mqtt_str2sub Create MQTT subscribe variable from string(s) + * * @csStr = strings * @strnum = number of strings elements * @qoses = QoS elements applied to subscribe variable, @@ -191,13 +201,23 @@ inline char mqtt_sizeLen(unsigned int len); */ inline mqtt_subscr_t *mqtt_str2sub(const char **csStr, unsigned short strnum, unsigned char *qoses); /* - * mqtt_freeSub() Free array from subscribe variables + * mqtt_subFree() Free array from subscribe variables * * @subs = Subscribe variables * return: none */ -inline void mqtt_freeSub(mqtt_subscr_t ** __restrict subs); +inline 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); + +/*** SENDER FUNCTIONS ***/ + /* * mqtt_msgCONNECT() Create CONNECT message * @@ -224,6 +244,27 @@ int mqtt_msgCONNECT(mqtt_msg_t * __restrict buf, const * return: -1 error or >-1 message size for send */ int mqtt_msgCONNACK(mqtt_msg_t * __restrict buf, unsigned char retcode); +/* + * mqtt_msgDISCONNECT() Create DISCONNECT message + * + * @buf = Message buffer + * return: -1 error or >-1 message size for send + */ +int mqtt_msgDISCONNECT(mqtt_msg_t * __restrict buf); +/* + * mqtt_msgPINGREQ() Create PINGREQ message + * + * @buf = Message buffer + * return: -1 error or >-1 message size for send + */ +int mqtt_msgPINGREQ(mqtt_msg_t * __restrict buf); +/* + * mqtt_msgPINGRESP() Create PINGRESP message + * + * @buf = Message buffer + * return: -1 error or >-1 message size for send + */ +int mqtt_msgPINGRESP(mqtt_msg_t * __restrict buf); /* * mqtt_msgPUBLISH() Create PUBLISH message @@ -287,6 +328,96 @@ inline int mqtt_msgPUBCOMP(mqtt_msg_t * __restrict buf int mqtt_msgSUBSCRIBE(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics, unsigned short msgID, unsigned char Dup, unsigned char QOS); +/* + * mqtt_msgSUBACK() Create SUBACK message + * + * @buf = Message buffer + * @Topics = MQTT subscription topics + * @msgID = MessageID + * return: -1 error or >-1 message size for send + */ +int mqtt_msgSUBACK(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics, + unsigned short msgID); +/* + * mqtt_msgUNSUBSCRIBE() Create UNSUBSCRIBE message + * + * @buf = Message buffer + * @Topics = MQTT subscription topics + * @msgID = MessageID + * @Dup = Duplicate message + * @QOS = QoS + * return: -1 error or >-1 message size for send + */ +int +mqtt_msgUNSUBSCRIBE(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics, + unsigned short msgID, unsigned char Dup, unsigned char QOS); +/* + * mqtt_msgUNSUBACK() Create UNSUBACK message + * + * @buf = Message buffer + * @msgID = MessageID + * return: -1 error or >-1 message size for send + */ +int mqtt_msgUNSUBACK(mqtt_msg_t * __restrict buf, unsigned short msgID); + + +/*** RECEIVER FUNCTIONS ***/ + +/* + * mqtt_readCONNECT() Read elements from CONNECT message + * + * @buf = Message buffer + * @kasec = Keep Alive in seconds for current connection + * @psConnID = ConnectID + * @connLen = ConnectID length + * @psUser = Username if !=NULL + * @userLen = Username length + * @psPass = Password for Username, only if csUser is set + * @passLen = Password length + * @psWillTopic = Will Topic if !=NULL Will Flags set into message + * @topicLen = Will Topic length + * @psWillMessage = Will Message, may be NULL + * @msgLen = Will Message length + * return: .reserved == 1 is error or == 0 connection flags & msg ok + */ +mqtthdr_connflgs_t mqtt_readCONNECT(mqtt_msg_t * __restrict buf, unsigned short *kasec, + char * __restrict psConnID, int connLen, + char * __restrict psUser, int userLen, char * __restrict psPass, int passLen, + char * __restrict psWillTopic, int topicLen, char * __restrict psWillMessage, int msgLen); + + +/*** ENGINE FUNCTIONS ***/ + +/* + * mqttInitCallbacks() Init callback array for dispatcher + * + * return: NULL error or !=NULL allocated callback array, after use free with mqttFiniCallbacks() + */ +mqtt_cb_t *mqttInitCallbacks(void); +/* + * mqttFiniCallbacks() Free callback array + * + * @cb = Callback array + * return: none + */ +void mqttFiniCallbacks(mqtt_cb_t ** __restrict cb); +/* + * MQTT_CALLBACK() Assign function to callback array for MQTT dispatcher + * + * @_cbs = Callback array + * @_x = MQTT Message type, like MQTT_TYPE_* ... + * @_func = Function + * return: none + */ +#define MQTT_CALLBACK(_cbs, _x, _func) (assert((_cbs)), (_cbs)[(_x)] = (_func)) +/* + * mqttDispatcher() MQTT Message type dispatcher + * + * @cb = Callback array + * @buf = Received MQTT message + * return: -1 error or >-1 return value from executed callback + */ +inline int mqttDispatcher(mqtt_cb_t * __restrict cb, mqtt_msg_t * __restrict buf); #endif