Annotation of mqtt/inc/aitmqtt.h, revision 1.1.1.1.2.13

1.1       misho       1: #ifndef __AITMQTT_H
                      2: #define __AITMQTT_H
                      3: 
                      4: 
1.1.1.1.2.3  misho       5: #define MQTT_DATA_MAX          268435455
1.1.1.1.2.4  misho       6: #define MQTT_CONN_STR          "MQIsdp"
                      7: #define MQTT_PROTO_VER         3
                      8: #define MQTT_KEEPALIVE         10
                      9: 
                     10: /* FIXED HEADER */
1.1.1.1.2.3  misho      11: 
1.1.1.1.2.1  misho      12: struct mqtthdr {
1.1.1.1.2.4  misho      13:        struct {
                     14:                unsigned char   retain:1, 
                     15:                                qos:2,
                     16:                                dup:1,
                     17:                                type:4;
                     18:        } mqtt_msg;
                     19:        unsigned char           mqtt_len[1];    /* may be grow to 4 bytes */
                     20: } __packed;
1.1.1.1.2.1  misho      21: 
                     22: #define MQTT_TYPE_UNKNOWN      0       /* reserved */
                     23: #define MQTT_TYPE_CONNECT      1       /* client request to connect to server */
                     24: #define MQTT_TYPE_CONNACK      2       /* connect acknowledgment */
                     25: #define MQTT_TYPE_PUBLISH      3       /* publish message */
                     26: #define MQTT_TYPE_PUBACK       4       /* publish acknowledgment */
                     27: #define MQTT_TYPE_PUBREC       5       /* publish received (assured delivery part 1) */
                     28: #define MQTT_TYPE_PUBREL       6       /* publish release (assured delivery part 2) */
                     29: #define MQTT_TYPE_PUBCOMP      7       /* publish complete (assured delivery part 3) */
                     30: #define MQTT_TYPE_SUBSCRIBE    8       /* client subscribe request */
                     31: #define MQTT_TYPE_SUBACK       9       /* subscribe acknowledgment */
                     32: #define MQTT_TYPE_UNSUBSCRIBE  10      /* client unsubscribe request */
                     33: #define MQTT_TYPE_UNSUBACK     11      /* unsubscribe acknowledgment */
                     34: #define MQTT_TYPE_PINGREQ      12      /* PING request */
                     35: #define MQTT_TYPE_PINGRESP     13      /* PING response */
                     36: #define MQTT_TYPE_DISCONNECT   14      /* client is disconnecting */
                     37: #define MQTT_TYPE_RESERVED     15      /* reserved */
                     38: 
                     39: #define MQTT_FLAG_DUP          1       /* This flag is set when the client or server attempts to re-deliver 
                     40:                                           a PUBLISH, PUBREL, SUBSCRIBE or UNSUBSCRIBE message. 
                     41:                                           This applies to messages where the value of QoS is greater than 
                     42:                                           zero (0), and an acknowledgment is required. 
                     43:                                           When the DUP bit is set, the variable header includes a Message ID.
                     44: 
                     45:                                           The recipient should treat this flag as a hint as to whether 
                     46:                                           the message may have been previously received. 
                     47:                                           It should not be relied on to detect duplicates. */
                     48: 
                     49: #define MQTT_QOS_ONCE          0       /* At most once, Fire and Forget, <=1 */
                     50: #define MQTT_QOS_ACK           1       /* At least once, Acknowledged delivery, >=1 */
                     51: #define MQTT_QOS_EXACTLY       2       /* Exactly once, Assured delivery, =1 */
                     52: #define MQTT_QOS_RESERVED      3       /* reserved */
                     53: 
                     54: #define MQTT_FLAG_RETAIN       1       /* This flag is only used on PUBLISH messages.
                     55: 
                     56:                                           When a client sends a PUBLISH to a server, 
                     57:                                           if the Retain flag is set (1), 
                     58:                                           the server should hold on to the message after it has been 
                     59:                                           delivered to the current subscribers.
                     60:                                           When a new subscription is established on a topic, 
                     61:                                           the last retained message on that topic should be sent to 
                     62:                                           the subscriber with the Retain flag set.
                     63:                                           If there is no retained message, nothing is sent
                     64:                                           This is useful where publishers send messages on a 
                     65:                                           "report by exception" basis, where it might be some time between messages. 
                     66:                                           This allows new subscribers to instantly receive data with the retained, 
                     67:                                           or Last Known Good, value.
                     68: 
                     69:                                           When a server sends a PUBLISH to a client as a result of 
                     70:                                           a subscription that already existed when the original PUBLISH arrived, 
                     71:                                           the Retain flag should not be set, regardless of the Retain flag 
                     72:                                           of the original PUBLISH. This allows a client to distinguish messages 
                     73:                                           that are being received because they were retained and those 
                     74:                                           that are being received "live".
                     75: 
                     76:                                           Retained messages should be kept over restarts of the server.
                     77:                                           A server may delete a retained message if it receives a message 
                     78:                                           with a zero-length payload and the Retain flag set on the same topic. */
                     79: 
1.1.1.1.2.4  misho      80: /* VARIABLE HEADERS */
                     81: 
                     82: #define MQTT_RETCODE_ACCEPTED          0
                     83: #define MQTT_RETCODE_REFUSE_VER                1
                     84: #define MQTT_RETCODE_REFUSE_ID         2
                     85: #define MQTT_RETCODE_REFUSE_UNAVAIL    3
                     86: #define MQTT_RETCODE_REFUSE_USERPASS   4
                     87: #define MQTT_RETCODE_DENIED            5
                     88: 
                     89: 
                     90: typedef union {
                     91:        struct {
                     92:                unsigned short  m:8,
                     93:                                l:8;
                     94:        } sb;
                     95:        unsigned short  val;
1.1.1.1.2.5  misho      96: } mqtt_v_t;
1.1.1.1.2.4  misho      97: 
                     98: typedef struct {
1.1.1.1.2.12  misho      99:        mqtt_v_t        sub_sb;
                    100:        char            *sub_data;
                    101:        unsigned char   sub_qos;
                    102: } mqtt_subscr_t;
                    103: 
                    104: typedef struct {
1.1.1.1.2.5  misho     105:        mqtt_v_t        var_sb;
1.1.1.1.2.4  misho     106:        unsigned char   var_data[0];
                    107: } __packed mqtthdr_var_t;
1.1.1.1.2.5  misho     108: #define MQTTHDR_VAR_SIZEOF(x)          (assert((x)), sizeof(mqtt_v_t) + ntohs((x)->var_sb.val))
1.1.1.1.2.4  misho     109: 
                    110: typedef unsigned char mqtthdr_protover_t;
                    111: 
                    112: typedef struct {
                    113:        unsigned char   reserved:1,
                    114:                        clean_sess:1,
                    115:                        will_flg:1,
                    116:                        will_qos:2,
                    117:                        will_retain:1,
                    118:                        password:1,
                    119:                        username:1;
                    120: } __packed mqtthdr_connflgs_t;
                    121: 
1.1.1.1.2.7  misho     122: typedef struct {
                    123:        unsigned char   reserved;
                    124:        unsigned char   retcode;
                    125: } __packed mqtthdr_connack_t;
                    126: 
1.1.1.1.2.1  misho     127: 
1.1.1.1.2.5  misho     128: /* MQTT Message buffer */
                    129: 
                    130: typedef struct {
                    131:        void            *msg_base;
                    132:        unsigned short  msg_len;
                    133: } mqtt_msg_t;
                    134: 
                    135: 
1.1       misho     136: // -------------------------------------------------------
                    137: // mqtt_GetErrno() Get error code of last operation
                    138: inline int mqtt_GetErrno();
                    139: // mqtt_GetError() Get error text of last operation
                    140: inline const char *mqtt_GetError();
                    141: // -------------------------------------------------------
                    142: 
                    143: 
1.1.1.1.2.1  misho     144: /*
1.1.1.1.2.5  misho     145:  * mqtt_msgAlloc() Allocate memory for MQTT Message
                    146:  * @len = >0 Allocate buffer with length
                    147:  * return: NULL error or Message, after use must call mqtt_msgFree() with all!=0
                    148:  */
                    149: inline mqtt_msg_t *mqtt_msgAlloc(unsigned short len);
                    150: /*
                    151:  * mqtt_msgFree() Free MQTT message
                    152:  * @msg = Message buffer
                    153:  * @all = !=0 Destroy entire message, if MQTT Message allocated with mqtt_msgAlloc()
                    154:  * return: none
                    155:  */
                    156: inline void mqtt_msgFree(mqtt_msg_t ** __restrict msg, int all);
                    157: /*
                    158:  * mqtt_msgRealloc() Reallocate MQTT message buffer
                    159:  * @msg = MQTT message
                    160:  * @len = new length
                    161:  * return: -1 error or >-1 old buffer length
                    162:  */
                    163: inline int mqtt_msgRealloc(mqtt_msg_t * __restrict msg, unsigned short len);
                    164: 
                    165: /*
1.1.1.1.2.1  misho     166:  * mqtt_encodeLen() Encode number to MQTT length field
                    167:  * @num = number for encode
                    168:  * return: -1 error or >-1 length
                    169:  */
                    170: inline unsigned int mqtt_encodeLen(unsigned int num);
                    171: /*
                    172:  * mqtt_decodeLen() Decode length from MQTT packet
                    173:  * @len = length
1.1.1.1.2.2  misho     174:  * @n = sizeof bytes, if !=NULL
1.1.1.1.2.1  misho     175:  * return: -1 error, >-1 length of message
                    176:  */
1.1.1.1.2.2  misho     177: inline unsigned int mqtt_decodeLen(unsigned int len, char *n);
                    178: /*
                    179:  * mqtt_sizeLen Return sizeof len field
                    180:  * @len = length
                    181:  * return: -1 error, >-1 sizeof len in bytes
                    182:  */
                    183: inline char mqtt_sizeLen(unsigned int len);
1.1.1.1.2.4  misho     184: /*
1.1.1.1.2.12  misho     185:  * mqtt_str2sub Create MQTT subscribe variable from string(s)
                    186:  * @csStr = strings
                    187:  * @strnum = number of strings elements
                    188:  * @qoses = QoS elements applied to subscribe variable, 
                    189:  *             count of elements must be equal with csStr elements
                    190:  * return: NULL error or != subscribe variables array, must be free after use with mqtt_freeSub()
                    191:  */
                    192: inline mqtt_subscr_t *mqtt_str2sub(const char **csStr, unsigned short strnum, unsigned char *qoses);
                    193: /*
                    194:  * mqtt_freeSub() Free array from subscribe variables
                    195:  *
                    196:  * @subs = Subscribe variables
                    197:  * return: none
1.1.1.1.2.4  misho     198:  */
1.1.1.1.2.12  misho     199: inline void mqtt_freeSub(mqtt_subscr_t ** __restrict subs);
1.1.1.1.2.1  misho     200: 
1.1.1.1.2.6  misho     201: /*
                    202:  * mqtt_msgCONNECT() Create CONNECT message
                    203:  *
                    204:  * @buf = Message buffer
                    205:  * @csConnID = ConnectID
                    206:  * @csUser = Username if !=NULL
                    207:  * @csPass = Password for Username, only if csUser is set
                    208:  * @csWillTopic = Will Topic if !=NULL Will Flags set into message
                    209:  * @csWillMessage = Will Message, may be NULL
                    210:  * @ClrSess = Clear Session subscriptions after disconnect
                    211:  * @WillQOS = Will QOS if csWillTopic is set
                    212:  * @WillRetain = Will Retain Will Message if csWillTopic is set
                    213:  * return: -1 error or >-1 message size for send
                    214:  */
                    215: int mqtt_msgCONNECT(mqtt_msg_t * __restrict buf, const char *csConnID, 
                    216:                const char *csUser, const char *csPass, 
                    217:                const char *csWillTopic, const char *csWillMessage, 
1.1.1.1.2.8  misho     218:                unsigned char ClrSess, unsigned char WillQOS, unsigned char WillRetain);
1.1.1.1.2.7  misho     219: /*
                    220:  * mqtt_msgCONNACK() Create CONNACK message
                    221:  *
                    222:  * @buf = Message buffer
                    223:  * @retcode = Return code
                    224:  * return: -1 error or >-1 message size for send
                    225:  */
1.1.1.1.2.8  misho     226: int mqtt_msgCONNACK(mqtt_msg_t * __restrict buf, unsigned char retcode);
1.1.1.1.2.13! misho     227: 
1.1.1.1.2.8  misho     228: /*
                    229:  * mqtt_msgPUBLISH() Create PUBLISH message
                    230:  *
                    231:  * @buf = Message buffer
                    232:  * @csTopic = Publish topic
                    233:  * @msgID = MessageID >0, if QOS != MQTT_QOS_ONCE
                    234:  * @Dup = Duplicate message
                    235:  * @QOS = QoS
1.1.1.1.2.10  misho     236:  * @Retain = Retain message
1.1.1.1.2.11  misho     237:  * @pData = Publish data into topic
                    238:  * @datlen = Publish data length
1.1.1.1.2.8  misho     239:  * return: -1 error or >-1 message size for send
                    240:  */
1.1.1.1.2.10  misho     241: int mqtt_msgPUBLISH(mqtt_msg_t * __restrict buf, const char *csTopic, unsigned short msgID, 
1.1.1.1.2.11  misho     242:                unsigned char Dup, unsigned char QOS, unsigned char Retain, 
                    243:                const void *pData, unsigned short datlen);
1.1.1.1.2.8  misho     244: /*
                    245:  * mqtt_msgPUBACK() Create PUBACK message
                    246:  *
                    247:  * @buf = Message buffer
                    248:  * @msgID = MessageID
                    249:  * return: -1 error or >-1 message size for send
                    250:  */
                    251: inline int mqtt_msgPUBACK(mqtt_msg_t * __restrict buf, unsigned short msgID);
                    252: /*
                    253:  * mqtt_msgPUBREC() Create PUBREC message
                    254:  *
                    255:  * @buf = Message buffer
                    256:  * @msgID = MessageID
                    257:  * return: -1 error or >-1 message size for send
                    258:  */
                    259: inline int mqtt_msgPUBREC(mqtt_msg_t * __restrict buf, unsigned short msgID);
                    260: /*
                    261:  * mqtt_msgPUBREL() Create PUBREL message
                    262:  *
                    263:  * @buf = Message buffer
                    264:  * @msgID = MessageID
                    265:  * return: -1 error or >-1 message size for send
                    266:  */
                    267: inline int mqtt_msgPUBREL(mqtt_msg_t * __restrict buf, unsigned short msgID);
                    268: /*
                    269:  * mqtt_msgPUBCOMP() Create PUBCOMP message
                    270:  *
                    271:  * @buf = Message buffer
                    272:  * @msgID = MessageID
                    273:  * return: -1 error or >-1 message size for send
                    274:  */
                    275: inline int mqtt_msgPUBCOMP(mqtt_msg_t * __restrict buf, unsigned short msgID);
1.1.1.1.2.6  misho     276: 
1.1.1.1.2.13! misho     277: /*
        !           278:  * mqtt_msgSUBSCRIBE() Create SUBSCRIBE message
        !           279:  *
        !           280:  * @buf = Message buffer
        !           281:  * @Topics = MQTT subscription topics
        !           282:  * @msgID = MessageID
        !           283:  * @Dup = Duplicate message
        !           284:  * @QOS = QoS
        !           285:  * return: -1 error or >-1 message size for send
        !           286:  */
        !           287: int
        !           288: mqtt_msgSUBSCRIBE(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics, 
        !           289:                unsigned short msgID, unsigned char Dup, unsigned char QOS);
        !           290: 
1.1.1.1.2.1  misho     291: 
1.1       misho     292: #endif

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