Annotation of libaitmqtt/inc/aitmqtt.h, revision 1.3.4.5
1.1 misho 1: /*************************************************************************
2: * (C) 2011 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
3: * by Michael Pounov <misho@openbsd-bg.org>
4: *
5: * $Author: misho $
1.3.4.5 ! misho 6: * $Id: aitmqtt.h,v 1.3.4.4 2022/09/12 23:07:18 misho Exp $
1.1 misho 7: *
8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
1.3.4.2 misho 15: Copyright 2004 - 2022
1.1 misho 16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
46: #ifndef __AITMQTT_H
47: #define __AITMQTT_H
48:
49:
1.2 misho 50: #define MAX_CONNID 24
51: #define MAX_CRED 13
1.3.4.2 misho 52: #define MQTTMSG_MAX 65535
1.3.4.3 misho 53: #define MQTTMSG_BIN_MAX 65535
1.2 misho 54: #define MQTT_DATA_MAX 268435455
55:
56: #define MQTT_PROTO_VER 3
1.3.4.5 ! misho 57: #define MQTT_PROTO_DEFVER 5
1.2 misho 58: #define MQTT_KEEPALIVE 10
59: #define MQTT_DEFAULT_MSGID 0xDEBA
60:
1.1 misho 61: /* FIXED HEADER */
62:
63: struct mqtthdr {
64: union {
65: struct {
66: unsigned char retain:1,
67: qos:2,
68: dup:1,
69: type:4;
70: };
71: unsigned char val;
72: } mqtt_msg;
73: unsigned char mqtt_len[1]; /* may be grow to 4 bytes */
1.3.4.1 misho 74: } __attribute__((packed));
1.3.4.3 misho 75: #define MQTTHDR_MSGINIT(x) (assert((x)), (x)->mqtt_msg.val ^= (x)->mqtt_msg.val, *mqtt_len = 0)
1.2 misho 76: #define MQTTHDR_DATA_SIZEOF(x) (assert((x)), mqtt_decodeLen((x)->mqtt_len, NULL))
1.1 misho 77:
78: #define MQTT_TYPE_UNKNOWN 0 /* reserved */
1.3.4.3 misho 79: #define MQTT_TYPE_CONNECT 1 /* client request to connect to server (CLI) */
1.3.4.4 misho 80: #define MQTT_TYPE_CONNACK 2 /* connect acknowledgment (SRV) [ret_no_data] */
81: #define MQTT_TYPE_PUBLISH 3 /* publish message [ret_is_optional] */
82: #define MQTT_TYPE_PUBACK 4 /* publish acknowledgment [ret_no_data] */
83: #define MQTT_TYPE_PUBREC 5 /* publish received (assured delivery part 1) [ret_no_data] */
84: #define MQTT_TYPE_PUBREL 6 /* publish release (assured delivery part 2) [ret_no_data] */
85: #define MQTT_TYPE_PUBCOMP 7 /* publish complete (assured delivery part 3) [ret_no_data] */
1.3.4.3 misho 86: #define MQTT_TYPE_SUBSCRIBE 8 /* client subscribe request (CLI) */
87: #define MQTT_TYPE_SUBACK 9 /* subscribe acknowledgment (SRV) */
88: #define MQTT_TYPE_UNSUBSCRIBE 10 /* client unsubscribe request (CLI) */
89: #define MQTT_TYPE_UNSUBACK 11 /* unsubscribe acknowledgment (SRV) */
1.3.4.4 misho 90: #define MQTT_TYPE_PINGREQ 12 /* PING request (CLI) [ret_no_data] */
91: #define MQTT_TYPE_PINGRESP 13 /* PING response (SRV) [ret_no_data] */
92: #define MQTT_TYPE_DISCONNECT 14 /* client is disconnecting [ret_no_data] */
93: #define MQTT_TYPE_AUTH 15 /* authentication exchange [ret_no_data] */
1.3.4.3 misho 94:
95: #define MQTT_TYPE_MAX 15
1.1 misho 96:
97: #define MQTT_FLAG_DUP 1 /* This flag is set when the client or server attempts to re-deliver
98: a PUBLISH, PUBREL, SUBSCRIBE or UNSUBSCRIBE message.
99: This applies to messages where the value of QoS is greater than
100: zero (0), and an acknowledgment is required.
101: When the DUP bit is set, the variable header includes a Message ID.
102:
103: The recipient should treat this flag as a hint as to whether
104: the message may have been previously received.
105: It should not be relied on to detect duplicates. */
106:
107: #define MQTT_QOS_ONCE 0 /* At most once, Fire and Forget, <=1 */
108: #define MQTT_QOS_ACK 1 /* At least once, Acknowledged delivery, >=1 */
109: #define MQTT_QOS_EXACTLY 2 /* Exactly once, Assured delivery, =1 */
110: #define MQTT_QOS_RESERVED 3 /* reserved */
111:
1.2 misho 112: #define MQTT_QOS_DENY 0 /* Not granted QoS for SUBACK */
113: #define MQTT_QOS_PASS 2 /* Granted QoS for SUBACK */
114:
1.1 misho 115: #define MQTT_FLAG_RETAIN 1 /* This flag is only used on PUBLISH messages.
116:
117: When a client sends a PUBLISH to a server,
118: if the Retain flag is set (1),
119: the server should hold on to the message after it has been
120: delivered to the current subscribers.
121: When a new subscription is established on a topic,
122: the last retained message on that topic should be sent to
123: the subscriber with the Retain flag set.
124: If there is no retained message, nothing is sent
125: This is useful where publishers send messages on a
126: "report by exception" basis, where it might be some time between messages.
127: This allows new subscribers to instantly receive data with the retained,
128: or Last Known Good, value.
129:
130: When a server sends a PUBLISH to a client as a result of
131: a subscription that already existed when the original PUBLISH arrived,
132: the Retain flag should not be set, regardless of the Retain flag
133: of the original PUBLISH. This allows a client to distinguish messages
134: that are being received because they were retained and those
135: that are being received "live".
136:
137: Retained messages should be kept over restarts of the server.
138: A server may delete a retained message if it receives a message
139: with a zero-length payload and the Retain flag set on the same topic. */
140:
141: /* VARIABLE HEADERS */
142:
143: #define MQTT_RETCODE_ACCEPTED 0
144: #define MQTT_RETCODE_REFUSE_VER 1
145: #define MQTT_RETCODE_REFUSE_ID 2
146: #define MQTT_RETCODE_REFUSE_UNAVAIL 3
147: #define MQTT_RETCODE_REFUSE_USERPASS 4
148: #define MQTT_RETCODE_DENIED 5
149:
1.3.4.4 misho 150: /* REASON CODES */
151:
152: #define MQTT_REASON_OK 0x0 /* CONNACK, PUBACK, PUBREC, PUBREL, PUBCOMP, UNSUBACK, AUTH, DISCONNECT, SUBACK */
153: #define MQTT_REASON_QOS1 0x1 /* SUBACK */
154: #define MQTT_REASON_QOS2 0x2 /* SUBACK */
155: #define MQTT_REASON_DWILL 0x4 /* DISCONNECT */
156: #define MQTT_REASON_NOMATCH 0x10 /* PUBACK, PUBREC */
157: #define MQTT_REASON_NOSUBEXIST 0x11 /* UNSUBACK */
158: #define MQTT_REASON_CONTAUTH 0x18 /* AUTH */
159: #define MQTT_REASON_REAUTH 0x19 /* AUTH */
160:
161: /* REASON ERROR CODES */
162:
163: #define MQTT_REASON_ERROR 0x80 /* CONNACK, PUBACK, PUBREC, SUBACK, UNSUBACK, DISCONNECT */
164: #define MQTT_REASON_MALFORMPKT 0x81 /* CONNACK, DISCONNECT */
165: #define MQTT_REASON_PROTOERR 0x82 /* CONNACK, DISCONNECT */
166: #define MQTT_REASON_IMPLSPECERR 0x83 /* CONNACK, PUBACK, PUBREC, SUBACK, UNSUBACK, DISCONNECT */
167: #define MQTT_REASON_UNSUPVERPROTO 0x84 /* CONNACK */
168: #define MQTT_REASON_CLINOVALID 0x85 /* CONNACK */
169: #define MQTT_REASON_BADUSERPASS 0x86 /* CONNACK */
170: #define MQTT_REASON_NOAUTH 0x87 /* CONNACK, PUBACK, PUBREC, SUBACK, UNSUBACK, DISCONNECT */
171: #define MQTT_REASON_SRVUNAVAIL 0x88 /* CONNACK */
172: #define MQTT_REASON_SRVBUSY 0x89 /* CONNACK, DISCONNECT */
173: #define MQTT_REASON_BANNED 0x8A /* CONNACK */
174: #define MQTT_REASON_SRVSHUTDOWN 0x8B /* DISCONNECT */
175: #define MQTT_REASON_BADAUTHMETHOD 0x8C /* CONNACK, DISCONNECT */
176: #define MQTT_REASON_KEEPALIVETO 0x8D /* DISCONNECT */
177: #define MQTT_REASON_SESTAKEOVER 0x8E /* DISCONNECT */
178: #define MQTT_REASON_TOPICFLTINVAL 0x8F /* SUBACK, UNSUBACK, DISCONNECT */
179: #define MQTT_REASON_TOPICNAMEINV 0x90 /* CONNACK, PUBACK, PUBREC, DISCONNECT */
180: #define MQTT_REASON_PKTIDINUSE 0x91 /* PUBACK, PUBREC, SUBACK, UNSUBACK */
181: #define MQTT_REASON_PKTIDNOTFOUND 0x92 /* PUBREL, PUBCOMP */
182: #define MQTT_REASON_RCVMAXEXCEED 0x93 /* DISCONNECT */
183: #define MQTT_REASON_TOPICALIASINV 0x94 /* DISCONNECT */
184: #define MQTT_REASON_PKTTOOLARGE 0x95 /* CONNACK, DISCONNECT */
185: #define MQTT_REASON_MSGRATETOHIGH 0x96 /* DISCONNECT */
186: #define MQTT_REASON_QUOTAEXCEED 0x97 /* CONNACK, PUBACK, PUBREC, SUBACK, DISCONNECT */
187: #define MQTT_REASON_ADMINACTION 0x98 /* DISCONNECT */
188: #define MQTT_REASON_PAYLOADFMTINV 0x99 /* CONNACK, PUBACK, PUBREC, DISCONNECT */
189: #define MQTT_REASON_RETAINNOTSUP 0x9A /* CONNACK, DISCONNECT */
190: #define MQTT_REASON_QOSNOTSUP 0x9B /* CONNACK, DISCONNECT */
191: #define MQTT_REASON_USENEXTSRV 0x9C /* CONNACK, DISCONNECT */
192: #define MQTT_REASON_SRVMOVED 0x9D /* CONNACK, DISCONNECT */
193: #define MQTT_REASON_SHARSUBNOTSUP 0x9E /* SUBACK, DISCONNECT */
194: #define MQTT_REASON_CONRATEEXCEED 0x9F /* CONNACK, DISCONNECT */
195: #define MQTT_REASON_MAXCONNTIME 0xA0 /* DISCONNECT */
196: #define MQTT_REASON_SUBIDNOTSUP 0xA1 /* SUBACK, DISCONNECT */
197: #define MQTT_RESON_WILDSUBNOTSUP 0xA2 /* SUBACK, DISCONNECT */
1.1 misho 198:
199: /* MQTT Message buffer */
200:
201: typedef struct {
202: void *msg_base;
203: unsigned short msg_len;
204: } mqtt_msg_t;
205:
206: /* MQTT structures */
207:
208: typedef union {
209: struct {
210: unsigned short m:8,
211: l:8;
212: } sb;
213: unsigned short val;
214: } mqtt_len_t;
215:
216: typedef struct {
217: unsigned char sub_ret;
218: mqtt_msg_t sub_topic;
219: mqtt_msg_t sub_value;
220: } mqtt_subscr_t;
221:
222: typedef struct {
223: mqtt_len_t var_sb;
224: unsigned char var_data[0];
1.3.4.1 misho 225: } __attribute__((packed)) mqtthdr_var_t;
1.1 misho 226: #define MQTTHDR_VAR_SIZEOF(x) (assert((x)), sizeof(mqtt_len_t) + ntohs((x)->var_sb.val))
227:
228: typedef unsigned char mqtthdr_protover_t;
229:
230: typedef union {
231: struct {
232: unsigned char reserved:1,
233: clean_sess:1,
234: will_flg:1,
235: will_qos:2,
236: will_retain:1,
237: password:1,
238: username:1;
239: };
240: unsigned char flags;
1.3.4.1 misho 241: } __attribute__((packed)) mqtthdr_connflgs_t;
1.1 misho 242:
243: typedef struct {
244: unsigned char reserved;
245: unsigned char retcode;
1.3.4.1 misho 246: } __attribute__((packed)) mqtthdr_connack_t;
1.1 misho 247:
248:
249: // -------------------------------------------------------
250: // mqtt_GetErrno() Get error code of last operation
1.3 misho 251: int mqtt_GetErrno();
1.1 misho 252: // mqtt_GetError() Get error text of last operation
1.3 misho 253: const char *mqtt_GetError();
1.1 misho 254: // -------------------------------------------------------
255:
256:
257: /*
258: * mqtt_msgAlloc() Allocate memory for MQTT Message
259: *
260: * @len = >0 Allocate buffer with length
261: * return: NULL error or Message, after use must call mqtt_msgFree() with all!=0
262: */
1.3 misho 263: mqtt_msg_t *mqtt_msgAlloc(unsigned short len);
1.1 misho 264: /*
265: * mqtt_msgFree() Free MQTT message
266: *
267: * @msg = Message buffer
268: * @all = !=0 Destroy entire message, if MQTT Message allocated with mqtt_msgAlloc()
269: * return: none
270: */
1.3 misho 271: void mqtt_msgFree(mqtt_msg_t ** __restrict msg, int all);
1.1 misho 272: /*
273: * mqtt_msgRealloc() Reallocate MQTT message buffer
274: *
275: * @msg = MQTT message
276: * @len = new length
277: * return: -1 error or >-1 old buffer length
278: */
1.3 misho 279: int mqtt_msgRealloc(mqtt_msg_t * __restrict msg, unsigned short len);
1.2 misho 280: /*
281: * mqtt_msgDup() - Duplicate message buffer
282: *
283: * @msg = Message
284: * return: NULL error or !=NULL duplicated message, after use must call mqtt_msgFree() with all!=0
285: */
1.3 misho 286: mqtt_msg_t *mqtt_msgDup(mqtt_msg_t * __restrict msg);
1.2 misho 287:
288: /*
289: * mqtt_expandTopic() - Expanding topic to regular expression
290: *
291: * @csInput = Input topic
292: * @psRegEx = Output to regular expression
293: * @regexLen = Length of psRegEx
294: * @BOL = Begin of Line, if =0 not added
295: * @EOL = End of Line, if =0 not appended
296: * return: -1 error, 0 nothing expanded or >0 expanded bytes
297: */
298: int mqtt_expandTopic(const char *csInput, char * __restrict psRegEx, int regexLen,
299: unsigned char BOL, unsigned char EOL);
300: /*
301: * mqtt_sqlTopic() - Expanding topic to SQL search string
302: *
303: * @csInput = Input topic
304: * @psSQL = Output to SQL search string
305: * @sqlLen = Length of psSQL
306: * return: -1 error, 0 changed bytes
307: */
308: int mqtt_sqlTopic(const char *csInput, char * __restrict psSQL, int sqlLen);
1.1 misho 309:
310: /*
311: * mqtt_encodeLen() Encode number to MQTT length field
312: *
313: * @num = number for encode
314: * return: -1 error or >-1 length
315: */
1.3 misho 316: unsigned int mqtt_encodeLen(unsigned int num);
1.1 misho 317: /*
318: * mqtt_decodeLen() Decode length from MQTT packet
319: *
320: * @len = length from MQTT header
321: * @n = sizeof bytes, if !=NULL
322: * return: -1 error, >-1 length of message
323: */
1.3 misho 324: unsigned int mqtt_decodeLen(void * __restrict len, int * __restrict n);
1.1 misho 325: /*
326: * mqtt_sizeLen Return sizeof len field
327: *
328: * @len = length
329: * return: -1 error, >-1 sizeof len in bytes
330: */
1.3 misho 331: char mqtt_sizeLen(unsigned int len);
1.1 misho 332: /*
1.2 misho 333: * mqtt_pktLen() - Get total packet length
1.1 misho 334: *
1.2 misho 335: * @hdr = MQTT packet header
336: * return: packet length
337: */
1.3 misho 338: unsigned int mqtt_pktLen(struct mqtthdr * __restrict hdr);
1.2 misho 339: /*
340: * mqtt_str2subs Create MQTT subscribe variable from string(s)
341: *
342: * @csStr = null terminated string array
343: * @strnum = copy at most number of strings elements
1.1 misho 344: * @qoses = QoS elements applied to subscribe variable,
345: * count of elements must be equal with csStr elements
346: * return: NULL error or != subscribe variables array, must be free after use with mqtt_freeSub()
347: */
1.3 misho 348: mqtt_subscr_t *mqtt_str2subs(const char **csStr, unsigned short strnum,
1.2 misho 349: unsigned char *qoses);
1.1 misho 350: /*
351: * mqtt_subFree() Free array from subscribe variables
352: *
353: * @subs = Subscribe variables
354: * return: none
355: */
1.3 misho 356: void mqtt_subFree(mqtt_subscr_t ** __restrict subs);
1.1 misho 357: /*
358: * mqtt_subAlloc() Create array from subscribe variables
359: *
360: * @num = Number of elements
361: * return: NULL error or subscribe array, after use must call mqtt_subFree()
362: */
1.3 misho 363: mqtt_subscr_t *mqtt_subAlloc(unsigned short num);
1.1 misho 364: /*
365: * mqtt_subRealloc() Reallocate array from subscribe variables
366: *
367: * @subs = Subscribe array
368: * @num = Number of elements
369: * return: NULL error or subscribe array, after use must call mqtt_subFree()
370: */
1.3 misho 371: mqtt_subscr_t *mqtt_subRealloc(mqtt_subscr_t ** __restrict subs, unsigned short num);
1.2 misho 372: /*
373: * mqtt_subCopy() - Copy subscription structure to another one
374: *
375: * @dst = destination subscription
376: * @src = source subscription
377: * return: =NULL error or !=NULL successful copied a structure
378: */
1.3 misho 379: mqtt_subscr_t *mqtt_subCopy(mqtt_subscr_t * __restrict dst, mqtt_subscr_t * __restrict src);
1.1 misho 380:
381:
382: /*** SENDER FUNCTIONS ***/
383:
384: /*
385: * mqtt_msgCONNECT() Create CONNECT message
386: *
387: * @buf = Message buffer
388: * @csConnID = ConnectID
1.2 misho 389: * @kasec = Keep alive timeout, if =0 default timeout for MQTT
1.1 misho 390: * @csUser = Username if !=NULL
391: * @csPass = Password for Username, only if csUser is set
392: * @csWillTopic = Will Topic if !=NULL Will Flags set into message
393: * @csWillMessage = Will Message, may be NULL
394: * @ClrSess = Clear Session subscriptions after disconnect
395: * @WillQOS = Will QOS if csWillTopic is set
396: * @WillRetain = Will Retain Will Message if csWillTopic is set
397: * return: -1 error or >-1 message size for send
398: */
399: int mqtt_msgCONNECT(mqtt_msg_t * __restrict buf, const char *csConnID,
400: unsigned short kasec, const char *csUser, const char *csPass,
401: const char *csWillTopic, const char *csWillMessage,
402: unsigned char ClrSess, unsigned char WillQOS, unsigned char WillRetain);
403: /*
404: * mqtt_msgCONNACK() Create CONNACK message
405: *
406: * @buf = Message buffer
407: * @retcode = Return code
408: * return: -1 error or >-1 message size for send
409: */
410: int mqtt_msgCONNACK(mqtt_msg_t * __restrict buf, unsigned char retcode);
411: /*
412: * mqtt_msgDISCONNECT() Create DISCONNECT message
413: *
414: * @buf = Message buffer
415: * return: -1 error or >-1 message size for send
416: */
417: int mqtt_msgDISCONNECT(mqtt_msg_t * __restrict buf);
418: /*
419: * mqtt_msgPINGREQ() Create PINGREQ message
420: *
421: * @buf = Message buffer
422: * return: -1 error or >-1 message size for send
423: */
424: int mqtt_msgPINGREQ(mqtt_msg_t * __restrict buf);
425: /*
426: * mqtt_msgPINGRESP() Create PINGRESP message
427: *
428: * @buf = Message buffer
429: * return: -1 error or >-1 message size for send
430: */
431: int mqtt_msgPINGRESP(mqtt_msg_t * __restrict buf);
432:
433: /*
434: * mqtt_msgPUBLISH() Create PUBLISH message
435: *
436: * @buf = Message buffer
437: * @csTopic = Publish topic
438: * @msgID = MessageID >0, if QOS != MQTT_QOS_ONCE
439: * @Dup = Duplicate message
440: * @QOS = QoS
441: * @Retain = Retain message
442: * @pData = Publish data into topic
443: * @datlen = Publish data length
444: * return: -1 error or >-1 message size for send
445: */
446: int mqtt_msgPUBLISH(mqtt_msg_t * __restrict buf, const char *csTopic,
447: unsigned short msgID, unsigned char Dup, unsigned char QOS,
448: unsigned char Retain, const void *pData, int datlen);
449: /*
450: * mqtt_msgPUBACK() Create PUBACK message
451: *
452: * @buf = Message buffer
453: * @msgID = MessageID
454: * return: -1 error or >-1 message size for send
455: */
1.3 misho 456: int mqtt_msgPUBACK(mqtt_msg_t * __restrict buf, unsigned short msgID);
1.1 misho 457: /*
458: * mqtt_msgPUBREC() Create PUBREC message
459: *
460: * @buf = Message buffer
461: * @msgID = MessageID
462: * return: -1 error or >-1 message size for send
463: */
1.3 misho 464: int mqtt_msgPUBREC(mqtt_msg_t * __restrict buf, unsigned short msgID);
1.1 misho 465: /*
466: * mqtt_msgPUBREL() Create PUBREL message
467: *
468: * @buf = Message buffer
469: * @msgID = MessageID
470: * return: -1 error or >-1 message size for send
471: */
1.3 misho 472: int mqtt_msgPUBREL(mqtt_msg_t * __restrict buf, unsigned short msgID);
1.1 misho 473: /*
474: * mqtt_msgPUBCOMP() Create PUBCOMP message
475: *
476: * @buf = Message buffer
477: * @msgID = MessageID
478: * return: -1 error or >-1 message size for send
479: */
1.3 misho 480: int mqtt_msgPUBCOMP(mqtt_msg_t * __restrict buf, unsigned short msgID);
1.1 misho 481:
482: /*
483: * mqtt_msgSUBSCRIBE() Create SUBSCRIBE message
484: *
485: * @buf = Message buffer
486: * @Topics = MQTT subscription topics
487: * @msgID = MessageID
488: * @Dup = Duplicate message
489: * @QOS = QoS
490: * return: -1 error or >-1 message size for send
491: */
492: int
493: mqtt_msgSUBSCRIBE(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics,
494: unsigned short msgID, unsigned char Dup, unsigned char QOS);
495: /*
496: * mqtt_msgSUBACK() Create SUBACK message
497: *
498: * @buf = Message buffer
499: * @Topics = MQTT subscription topics
500: * @msgID = MessageID
501: * return: -1 error or >-1 message size for send
502: */
503: int mqtt_msgSUBACK(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics,
504: unsigned short msgID);
505: /*
506: * mqtt_msgUNSUBSCRIBE() Create UNSUBSCRIBE message
507: *
508: * @buf = Message buffer
509: * @Topics = MQTT subscription topics
510: * @msgID = MessageID
511: * @Dup = Duplicate message
512: * @QOS = QoS
513: * return: -1 error or >-1 message size for send
514: */
515: int
516: mqtt_msgUNSUBSCRIBE(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics,
517: unsigned short msgID, unsigned char Dup, unsigned char QOS);
518: /*
519: * mqtt_msgUNSUBACK() Create UNSUBACK message
520: *
521: * @buf = Message buffer
522: * @msgID = MessageID
523: * return: -1 error or >-1 message size for send
524: */
525: int mqtt_msgUNSUBACK(mqtt_msg_t * __restrict buf, unsigned short msgID);
526:
527:
528: /*** RECEIVER FUNCTIONS ***/
529:
530: /*
531: * mqtt_readCONNECT() Read elements from CONNECT message
532: *
533: * @buf = Message buffer
534: * @kasec = Keep Alive in seconds for current connection
535: * @psConnID = ConnectID
536: * @connLen = ConnectID length
537: * @psUser = Username if !=NULL
538: * @userLen = Username length
539: * @psPass = Password for Username, only if csUser is set
540: * @passLen = Password length
541: * @psWillTopic = Will Topic if !=NULL Will Flags set into message and must be free()
542: * @psWillMessage = Will Message, may be NULL if !NULL must be free() after use!
543: * return: .reserved == 1 is error or == 0 connection flags & msg ok
544: */
545: mqtthdr_connack_t mqtt_readCONNECT(mqtt_msg_t * __restrict buf, unsigned short *kasec,
546: char * __restrict psConnID, int connLen,
547: char * __restrict psUser, int userLen, char * __restrict psPass, int passLen,
548: char ** __restrict psWillTopic, char ** __restrict psWillMessage);
549: /*
550: * mqtt_readCONNACK() Read CONNACK message
551: *
552: * @buf = Message buffer
553: * return: -1 error or >-1 CONNECT message return code
554: */
555: unsigned char mqtt_readCONNACK(mqtt_msg_t * __restrict buf);
556: /*
557: * mqtt_readDISCONNECT() Read DISCONNECT message
558: *
559: * @buf = Message buffer
560: * return: -1 error, 0 ok, >0 undefined result
561: */
562: int mqtt_readDISCONNECT(mqtt_msg_t * __restrict buf);
563: /*
564: * mqtt_readPINGREQ() Read PINGREQ message
565: *
566: * @buf = Message buffer
567: * return: -1 error, 0 ok, >0 undefined result
568: */
569: int mqtt_readPINGREQ(mqtt_msg_t * __restrict buf);
570: /*
571: * mqtt_readPINGRESP() Read PINGRESP message
572: *
573: * @buf = Message buffer
574: * return: -1 error, 0 ok, >0 undefined result
575: */
576: int mqtt_readPINGRESP(mqtt_msg_t * __restrict buf);
577:
578: /*
579: * mqtt_readPUBLISH() Read PUBLISH message
580: *
581: * @buf = Message buffer
582: * @psTopic = Topic
583: * @topicLen = Topic length
584: * @msgID = MessageID
1.2 misho 585: * @pData = Data buffer, may be NULL
586: * return: -1 error or !=-1 allocated data buffer length
1.1 misho 587: */
1.2 misho 588: int mqtt_readPUBLISH(mqtt_msg_t * __restrict buf, char * __restrict psTopic,
589: int topicLen, unsigned short *msgID, void ** __restrict pData);
1.1 misho 590: /*
591: * mqtt_readPUBACK() Read PUBACK message
592: *
593: * @buf = Message buffer
594: * return: -1 error or MessageID
595: */
1.2 misho 596: unsigned short mqtt_readPUBACK(mqtt_msg_t * __restrict buf);
1.1 misho 597: /*
598: * mqtt_readPUBREC() Read PUBREC message
599: *
600: * @buf = Message buffer
601: * return: -1 error or MessageID
602: */
1.2 misho 603: unsigned short mqtt_readPUBREC(mqtt_msg_t * __restrict buf);
1.1 misho 604: /*
605: * mqtt_readPUBREL() Read PUBREL message
606: *
607: * @buf = Message buffer
608: * return: -1 error or MessageID
609: */
1.2 misho 610: unsigned short mqtt_readPUBREL(mqtt_msg_t * __restrict buf);
1.1 misho 611: /*
612: * mqtt_readPUBCOMP() Read PUBCOMP message
613: *
614: * @buf = Message buffer
615: * return: -1 error or MessageID
616: */
1.2 misho 617: unsigned short mqtt_readPUBCOMP(mqtt_msg_t * __restrict buf);
1.1 misho 618:
619: /*
620: * mqtt_readSUBSCRIBE() Read SUBSCRIBE message
621: *
622: * @buf = Message buffer
623: * @msgID = MessageID
624: * @subscr = Subscriptions, must be free after use with mqtt_subFree()
1.2 misho 625: * return: -1 error or >-1 elements into subscr
1.1 misho 626: */
1.2 misho 627: int mqtt_readSUBSCRIBE(mqtt_msg_t * __restrict buf, unsigned short *msgID,
1.1 misho 628: mqtt_subscr_t **subscr);
629: /*
630: * mqtt_readSUBACK() Read SUBACK message
631: *
632: * @buf = Message buffer
633: * @msgID = MessageID
634: * @subqos = Subscribes QoS, must be free after use with free()
635: * return: -1 error or >-1 readed subscribes QoS elements
636: */
1.2 misho 637: int mqtt_readSUBACK(mqtt_msg_t * __restrict buf, unsigned short *msgID, unsigned char **subqos);
1.1 misho 638: /*
639: * mqtt_readUNSUBSCRIBE() Read UNSUBSCRIBE message
640: *
641: * @buf = Message buffer
642: * @msgID = MessageID
643: * @subscr = Subscriptions, must be free after use with mqtt_subFree()
1.2 misho 644: * return: -1 error or >-1 elements into subscr
1.1 misho 645: */
1.2 misho 646: int mqtt_readUNSUBSCRIBE(mqtt_msg_t * __restrict buf, unsigned short *msgID,
1.1 misho 647: mqtt_subscr_t **subscr);
648: /*
649: * mqtt_readUNSUBACK() Read UNSUBACK message
650: *
651: * @buf = Message buffer
652: * return: -1 error or MessageID
653: */
1.2 misho 654: unsigned short mqtt_readUNSUBACK(mqtt_msg_t * __restrict buf);
1.1 misho 655:
656:
657: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aitmqtt.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitmqtt / inc