Diff for /mqtt/inc/Attic/aitmqtt.h between versions 1.1.1.1.2.16 and 1.1.1.1.2.34

version 1.1.1.1.2.16, 2011/11/22 13:03:25 version 1.1.1.1.2.34, 2011/12/13 15:23:43
Line 2 Line 2
 #define __AITMQTT_H  #define __AITMQTT_H
   
   
 #define MQTT_DATA_MAX           268435455  
 #define MQTT_CONN_STR           "MQIsdp"  
 #define MQTT_PROTO_VER          3  
 #define MQTT_KEEPALIVE          10  
   
 /* FIXED HEADER */  /* FIXED HEADER */
   
 struct mqtthdr {  struct mqtthdr {
        struct {        union {
                unsigned char   retain:1,                 struct {
                                qos:2,                        unsigned char   retain:1, 
                                dup:1,                                        qos:2,
                                type:4;                                        dup:1,
                                         type:4;
                 };
                 unsigned char           val;
         } mqtt_msg;          } 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;  } __packed;
   #define MQTTHDR_MSGINIT(x)      (assert((x)), (x)->mqtt_msg.val ^= (x)->mqtt_msg.val)
   
 #define MQTT_TYPE_UNKNOWN       0       /* reserved */  #define MQTT_TYPE_UNKNOWN       0       /* reserved */
 #define MQTT_TYPE_CONNECT       1       /* client request to connect to server */  #define MQTT_TYPE_CONNECT       1       /* client request to connect to server */
Line 34  struct mqtthdr { Line 33  struct mqtthdr {
 #define MQTT_TYPE_PINGREQ       12      /* PING request */  #define MQTT_TYPE_PINGREQ       12      /* PING request */
 #define MQTT_TYPE_PINGRESP      13      /* PING response */  #define MQTT_TYPE_PINGRESP      13      /* PING response */
 #define MQTT_TYPE_DISCONNECT    14      /* client is disconnecting */  #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   #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.                                              a PUBLISH, PUBREL, SUBSCRIBE or UNSUBSCRIBE message. 
Line 96  typedef union { Line 95  typedef union {
 } mqtt_v_t;  } mqtt_v_t;
   
 typedef struct {  typedef struct {
        mqtt_v_t        sub_sb;        unsigned char   sub_ret;
        char            *sub_data;        struct __sbuf   sub_topic;
        unsigned char   sub_qos;        struct __sbuf   sub_value;
 } mqtt_subscr_t;  } mqtt_subscr_t;
   
 typedef struct {  typedef struct {
Line 109  typedef struct { Line 108  typedef struct {
   
 typedef unsigned char mqtthdr_protover_t;  typedef unsigned char mqtthdr_protover_t;
   
typedef struct {typedef union {
        unsigned char   reserved:1,        struct {
                        clean_sess:1,                unsigned char   reserved:1,
                        will_flg:1,                                clean_sess:1,
                        will_qos:2,                                will_flg:1,
                        will_retain:1,                                will_qos:2,
                        password:1,                                will_retain:1,
                        username:1;                                password:1,
                                 username:1;
         };
         unsigned char           flags;
 } __packed mqtthdr_connflgs_t;  } __packed mqtthdr_connflgs_t;
   
 typedef struct {  typedef struct {
Line 132  typedef struct { Line 134  typedef struct {
         unsigned short  msg_len;          unsigned short  msg_len;
 } mqtt_msg_t;  } mqtt_msg_t;
   
   /* MQTT dispatcher callbacks */
   
   typedef int (*mqtt_cb_t)(void *);
   
   
 // -------------------------------------------------------  // -------------------------------------------------------
 // mqtt_GetErrno() Get error code of last operation  // mqtt_GetErrno() Get error code of last operation
 inline int mqtt_GetErrno();  inline int mqtt_GetErrno();
Line 175  inline unsigned int mqtt_encodeLen(unsigned int num); Line 181  inline unsigned int mqtt_encodeLen(unsigned int num);
 /*  /*
  * mqtt_decodeLen() Decode length from MQTT packet   * mqtt_decodeLen() Decode length from MQTT packet
  *   *
 * @len = length * @len = length from MQTT header
  * @n = sizeof bytes, if !=NULL   * @n = sizeof bytes, if !=NULL
  * return: -1 error, >-1 length of message   * 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   * mqtt_sizeLen Return sizeof len field
  *   *
Line 211  inline void mqtt_subFree(mqtt_subscr_t ** __restrict s Line 217  inline void mqtt_subFree(mqtt_subscr_t ** __restrict s
  * return: NULL error or subscribe array, after use must call mqtt_subFree()   * return: NULL error or subscribe array, after use must call mqtt_subFree()
  */   */
 inline mqtt_subscr_t *mqtt_subAlloc(unsigned short num);  inline mqtt_subscr_t *mqtt_subAlloc(unsigned short num);
   /*
    * mqtt_subRealloc() Reallocate array from subscribe variables
    *
    * @subs = Subscribe array
    * @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);
   
   
   /*** SENDER FUNCTIONS ***/
   
 /*  /*
  * mqtt_msgCONNECT() Create CONNECT message   * mqtt_msgCONNECT() Create CONNECT message
  *   *
  * @buf = Message buffer   * @buf = Message buffer
  * @csConnID = ConnectID   * @csConnID = ConnectID
    * @kasec = Keep alive timeout
  * @csUser = Username if !=NULL   * @csUser = Username if !=NULL
  * @csPass = Password for Username, only if csUser is set   * @csPass = Password for Username, only if csUser is set
  * @csWillTopic = Will Topic if !=NULL Will Flags set into message   * @csWillTopic = Will Topic if !=NULL Will Flags set into message
Line 227  inline mqtt_subscr_t *mqtt_subAlloc(unsigned short num Line 245  inline mqtt_subscr_t *mqtt_subAlloc(unsigned short num
  * return: -1 error or >-1 message size for send   * return: -1 error or >-1 message size for send
  */   */
 int mqtt_msgCONNECT(mqtt_msg_t * __restrict buf, const char *csConnID,   int mqtt_msgCONNECT(mqtt_msg_t * __restrict buf, const char *csConnID, 
                const char *csUser, const char *csPass,                 unsigned short kasec, const char *csUser, const char *csPass, 
                 const char *csWillTopic, const char *csWillMessage,                   const char *csWillTopic, const char *csWillMessage, 
                 unsigned char ClrSess, unsigned char WillQOS, unsigned char WillRetain);                  unsigned char ClrSess, unsigned char WillQOS, unsigned char WillRetain);
 /*  /*
Line 238  int mqtt_msgCONNECT(mqtt_msg_t * __restrict buf, const Line 256  int mqtt_msgCONNECT(mqtt_msg_t * __restrict buf, const
  * return: -1 error or >-1 message size for send   * return: -1 error or >-1 message size for send
  */   */
 int mqtt_msgCONNACK(mqtt_msg_t * __restrict buf, unsigned char retcode);  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   * mqtt_msgPUBLISH() Create PUBLISH message
Line 252  int mqtt_msgCONNACK(mqtt_msg_t * __restrict buf, unsig Line 291  int mqtt_msgCONNACK(mqtt_msg_t * __restrict buf, unsig
  * @datlen = Publish data length   * @datlen = Publish data length
  * return: -1 error or >-1 message size for send   * return: -1 error or >-1 message size for send
  */   */
int mqtt_msgPUBLISH(mqtt_msg_t * __restrict buf, const char *csTopic, unsigned short msgID, int mqtt_msgPUBLISH(mqtt_msg_t * __restrict buf, const char *csTopic, 
                unsigned char Dup, unsigned char QOS, unsigned char Retain,                 unsigned short msgID, unsigned char Dup, unsigned char QOS, 
                const void *pData, unsigned short datlen);                unsigned char Retain, const void *pData, int datlen);
 /*  /*
  * mqtt_msgPUBACK() Create PUBACK message   * mqtt_msgPUBACK() Create PUBACK message
  *   *
Line 311  mqtt_msgSUBSCRIBE(mqtt_msg_t * __restrict buf, mqtt_su Line 350  mqtt_msgSUBSCRIBE(mqtt_msg_t * __restrict buf, mqtt_su
  */   */
 int mqtt_msgSUBACK(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics,   int mqtt_msgSUBACK(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics, 
                 unsigned short msgID);                  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 and must be free()
    * @psWillMessage = Will Message, may be NULL if !NULL must be free() after use!
    * return: .reserved == 1 is error or == 0 connection flags & msg ok
    */
   mqtthdr_connack_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, char ** __restrict psWillMessage);
   /*
    * mqtt_readCONNACK() Read CONNACK message
    *
    * @buf = Message buffer
    * return: -1 error or >-1 CONNECT message return code
    */
   unsigned char mqtt_readCONNACK(mqtt_msg_t * __restrict buf);
   /*
    * mqtt_readDISCONNECT() Read DISCONNECT message
    *
    * @buf = Message buffer
    * return: -1 error, 0 ok, >0 undefined result
    */
   int mqtt_readDISCONNECT(mqtt_msg_t * __restrict buf);
   /*
    * mqtt_readPINGREQ() Read PINGREQ message
    *
    * @buf = Message buffer
    * return: -1 error, 0 ok, >0 undefined result
    */
   int mqtt_readPINGREQ(mqtt_msg_t * __restrict buf);
   /*
    * mqtt_readPINGRESP() Read PINGRESP message
    *
    * @buf = Message buffer
    * return: -1 error, 0 ok, >0 undefined result
    */
   int mqtt_readPINGRESP(mqtt_msg_t * __restrict buf);
   
   /*
    * mqtt_readPUBLISH() Read PUBLISH message
    *
    * @buf = Message buffer
    * @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
    */
   struct mqtthdr *mqtt_readPUBLISH(mqtt_msg_t * __restrict buf, char * __restrict psTopic, 
                   int topicLen, unsigned short *msgID, void * __restrict pData, int *datLen);
   /*
    * mqtt_readPUBACK() Read PUBACK message
    *
    * @buf = Message buffer
    * return: -1 error or MessageID
    */
   u_short mqtt_readPUBACK(mqtt_msg_t * __restrict buf);
   /*
    * mqtt_readPUBREC() Read PUBREC message
    *
    * @buf = Message buffer
    * return: -1 error or MessageID
    */
   u_short mqtt_readPUBREC(mqtt_msg_t * __restrict buf);
   /*
    * mqtt_readPUBREL() Read PUBREL message
    *
    * @buf = Message buffer
    * return: -1 error or MessageID
    */
   u_short mqtt_readPUBREL(mqtt_msg_t * __restrict buf);
   /*
    * mqtt_readPUBCOMP() Read PUBCOMP message
    *
    * @buf = Message buffer
    * return: -1 error or MessageID
    */
   u_short mqtt_readPUBCOMP(mqtt_msg_t * __restrict buf);
   
   /*
    * mqtt_readSUBSCRIBE() Read SUBSCRIBE message
    *
    * @buf = Message buffer
    * @msgID = MessageID
    * @subscr = Subscriptions, must be free after use with mqtt_subFree()
    * return: NULL error or !=NULL MQTT fixed header
    */
   struct mqtthdr *mqtt_readSUBSCRIBE(mqtt_msg_t * __restrict buf, unsigned short *msgID, 
                   mqtt_subscr_t **subscr);
   /*
    * mqtt_readSUBACK() Read SUBACK message
    *
    * @buf = Message buffer
    * @msgID = MessageID
    * @subqos = Subscribes QoS, must be free after use with free()
    * return: -1 error or >-1 readed subscribes QoS elements
    */
   int mqtt_readSUBACK(mqtt_msg_t * __restrict buf, u_short *msgID, unsigned char **subqos);
   /*
    * mqtt_readUNSUBSCRIBE() Read UNSUBSCRIBE message
    *
    * @buf = Message buffer
    * @msgID = MessageID
    * @subscr = Subscriptions, must be free after use with mqtt_subFree()
    * return: NULL error or !=NULL MQTT fixed header
    */
   struct mqtthdr *mqtt_readUNSUBSCRIBE(mqtt_msg_t * __restrict buf, unsigned short *msgID, 
                   mqtt_subscr_t **subscr);
   /*
    * mqtt_readUNSUBACK() Read UNSUBACK message
    *
    * @buf = Message buffer
    * return: -1 error or MessageID
    */
   u_short mqtt_readUNSUBACK(mqtt_msg_t * __restrict buf);
   
   /*** 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  #endif

Removed from v.1.1.1.1.2.16  
changed lines
  Added in v.1.1.1.1.2.34


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>