libaitmqtt/inc/aitmqtt.h - diff

Return to aitmqtt.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libaitmqtt / inc

Diff for /libaitmqtt/inc/aitmqtt.h between versions 1.1.1.1.2.10 and 1.3.4.3

version 1.1.1.1.2.10, 2012/04/26 15:26:37	version 1.3.4.3, 2022/09/12 22:09:29
Line 12 terms:	Line 12 terms:
All of the documentation and software included in the ELWIX and AITNET	All of the documentation and software included in the ELWIX and AITNET
Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>	Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>

Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012	Copyright 2004 - 2022
by Michael Pounov <misho@elwix.org>. All rights reserved.	by Michael Pounov <misho@elwix.org>. All rights reserved.

Redistribution and use in source and binary forms, with or without	Redistribution and use in source and binary forms, with or without
Line 49 SUCH DAMAGE.	Line 49 SUCH DAMAGE.

#define MAX_CONNID 24	#define MAX_CONNID 24
#define MAX_CRED 13	#define MAX_CRED 13
#define MQTTMSG_MAX 65529	#define MQTTMSG_MAX 65535
	#define MQTTMSG_BIN_MAX 65535
#define MQTT_DATA_MAX 268435455	#define MQTT_DATA_MAX 268435455

#define MQTT_PROTO_VER 3	#define MQTT_PROTO_VER 3
Line 69 struct mqtthdr {	Line 70 struct mqtthdr {
unsigned char val;	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;	} __attribute__((packed));
#define MQTTHDR_MSGINIT(x) (assert((x)), (x)->mqtt_msg.val ^= (x)->mqtt_msg.val)	#define MQTTHDR_MSGINIT(x) (assert((x)), (x)->mqtt_msg.val ^= (x)->mqtt_msg.val, *mqtt_len = 0)
	#define MQTTHDR_DATA_SIZEOF(x) (assert((x)), mqtt_decodeLen((x)->mqtt_len, NULL))

#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 (CLI) */
#define MQTT_TYPE_CONNACK 2 /* connect acknowledgment */	#define MQTT_TYPE_CONNACK 2 /* connect acknowledgment (SRV) */
#define MQTT_TYPE_PUBLISH 3 /* publish message */	#define MQTT_TYPE_PUBLISH 3 /* publish message */
#define MQTT_TYPE_PUBACK 4 /* publish acknowledgment */	#define MQTT_TYPE_PUBACK 4 /* publish acknowledgment */
#define MQTT_TYPE_PUBREC 5 /* publish received (assured delivery part 1) */	#define MQTT_TYPE_PUBREC 5 /* publish received (assured delivery part 1) */
#define MQTT_TYPE_PUBREL 6 /* publish release (assured delivery part 2) */	#define MQTT_TYPE_PUBREL 6 /* publish release (assured delivery part 2) */
#define MQTT_TYPE_PUBCOMP 7 /* publish complete (assured delivery part 3) */	#define MQTT_TYPE_PUBCOMP 7 /* publish complete (assured delivery part 3) */
#define MQTT_TYPE_SUBSCRIBE 8 /* client subscribe request */	#define MQTT_TYPE_SUBSCRIBE 8 /* client subscribe request (CLI) */
#define MQTT_TYPE_SUBACK 9 /* subscribe acknowledgment */	#define MQTT_TYPE_SUBACK 9 /* subscribe acknowledgment (SRV) */
#define MQTT_TYPE_UNSUBSCRIBE 10 /* client unsubscribe request */	#define MQTT_TYPE_UNSUBSCRIBE 10 /* client unsubscribe request (CLI) */
#define MQTT_TYPE_UNSUBACK 11 /* unsubscribe acknowledgment */	#define MQTT_TYPE_UNSUBACK 11 /* unsubscribe acknowledgment (SRV) */
#define MQTT_TYPE_PINGREQ 12 /* PING request */	#define MQTT_TYPE_PINGREQ 12 /* PING request (CLI) */
#define MQTT_TYPE_PINGRESP 13 /* PING response */	#define MQTT_TYPE_PINGRESP 13 /* PING response (SRV) */
#define MQTT_TYPE_DISCONNECT 14 /* client is disconnecting */	#define MQTT_TYPE_DISCONNECT 14 /* client is disconnecting */
#define MQTT_TYPE_MAX 15 /* reserved */	#define MQTT_TYPE_AUTH 15 /* authentication exchange */

	#define MQTT_TYPE_MAX 15

#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.
This applies to messages where the value of QoS is greater than	This applies to messages where the value of QoS is greater than
Line 169 typedef struct {	Line 173 typedef struct {
typedef struct {	typedef struct {
mqtt_len_t var_sb;	mqtt_len_t var_sb;
unsigned char var_data[0];	unsigned char var_data[0];
} __packed mqtthdr_var_t;	} __attribute__((packed)) mqtthdr_var_t;
#define MQTTHDR_VAR_SIZEOF(x) (assert((x)), sizeof(mqtt_len_t) + ntohs((x)->var_sb.val))	#define MQTTHDR_VAR_SIZEOF(x) (assert((x)), sizeof(mqtt_len_t) + ntohs((x)->var_sb.val))

typedef unsigned char mqtthdr_protover_t;	typedef unsigned char mqtthdr_protover_t;
Line 185 typedef union {	Line 189 typedef union {
username:1;	username:1;
};	};
unsigned char flags;	unsigned char flags;
} __packed mqtthdr_connflgs_t;	} __attribute__((packed)) mqtthdr_connflgs_t;

typedef struct {	typedef struct {
unsigned char reserved;	unsigned char reserved;
unsigned char retcode;	unsigned char retcode;
} __packed mqtthdr_connack_t;	} __attribute__((packed)) mqtthdr_connack_t;


// -------------------------------------------------------	// -------------------------------------------------------
// mqtt_GetErrno() Get error code of last operation	// mqtt_GetErrno() Get error code of last operation
inline int mqtt_GetErrno();	int mqtt_GetErrno();
// mqtt_GetError() Get error text of last operation	// mqtt_GetError() Get error text of last operation
inline const char *mqtt_GetError();	const char *mqtt_GetError();
// -------------------------------------------------------	// -------------------------------------------------------


Line 207 inline const char *mqtt_GetError();	Line 211 inline const char *mqtt_GetError();
* @len = >0 Allocate buffer with length	* @len = >0 Allocate buffer with length
* return: NULL error or Message, after use must call mqtt_msgFree() with all!=0	* 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	* mqtt_msgFree() Free MQTT message
*	*
Line 215 inline mqtt_msg_t *mqtt_msgAlloc(unsigned short len);	Line 219 inline mqtt_msg_t *mqtt_msgAlloc(unsigned short len);
* @all = !=0 Destroy entire message, if MQTT Message allocated with mqtt_msgAlloc()	* @all = !=0 Destroy entire message, if MQTT Message allocated with mqtt_msgAlloc()
* return: none	* 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	* mqtt_msgRealloc() Reallocate MQTT message buffer
*	*
Line 223 inline void mqtt_msgFree(mqtt_msg_t ** __restrict msg,	Line 227 inline void mqtt_msgFree(mqtt_msg_t ** __restrict msg,
* @len = new length	* @len = new length
* return: -1 error or >-1 old buffer 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	* mqtt_expandTopic() - Expanding topic to regular expression
Line 253 int mqtt_sqlTopic(const char csInput, char __restri	Line 264 int mqtt_sqlTopic(const char csInput, char __restri
* @num = number for encode	* @num = number for encode
* return: -1 error or >-1 length	* 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	* mqtt_decodeLen() Decode length from MQTT packet
*	*
Line 261 inline unsigned int mqtt_encodeLen(unsigned int num);	Line 272 inline unsigned int mqtt_encodeLen(unsigned int num);
* @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(void * __restrict len, int * __restrict n);	unsigned int mqtt_decodeLen(void * __restrict len, int * __restrict n);
/*	/*
* mqtt_sizeLen Return sizeof len field	* mqtt_sizeLen Return sizeof len field
*	*
* @len = length	* @len = length
* return: -1 error, >-1 sizeof len in bytes	* return: -1 error, >-1 sizeof len in bytes
*/	*/
inline char mqtt_sizeLen(unsigned int len);	char mqtt_sizeLen(unsigned int len);
/*	/*
	* mqtt_pktLen() - Get total packet length
	*
	* @hdr = MQTT packet header
	* return: packet length
	*/
	unsigned int mqtt_pktLen(struct mqtthdr * __restrict hdr);
	/*
* mqtt_str2subs Create MQTT subscribe variable from string(s)	* mqtt_str2subs Create MQTT subscribe variable from string(s)
*	*
* @csStr = null terminated string array	* @csStr = null terminated string array
Line 278 inline char mqtt_sizeLen(unsigned int len);	Line 296 inline char mqtt_sizeLen(unsigned int len);
* count of elements must be equal with csStr elements	* count of elements must be equal with csStr elements
* return: NULL error or != subscribe variables array, must be free after use with mqtt_freeSub()	* return: NULL error or != subscribe variables array, must be free after use with mqtt_freeSub()
*/	*/
inline mqtt_subscr_t mqtt_str2subs(const char *csStr, unsigned short strnum,	mqtt_subscr_t mqtt_str2subs(const char *csStr, unsigned short strnum,
unsigned char *qoses);	unsigned char *qoses);
/*	/*
* mqtt_subFree() Free array from subscribe variables	* mqtt_subFree() Free array from subscribe variables
Line 286 inline mqtt_subscr_t mqtt_str2subs(const char *csStr	Line 304 inline mqtt_subscr_t mqtt_str2subs(const char *csStr
* @subs = Subscribe variables	* @subs = Subscribe variables
* return: none	* 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	* mqtt_subAlloc() Create array from subscribe variables
*	*
* @num = Number of elements	* @num = Number of elements
* 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);	mqtt_subscr_t *mqtt_subAlloc(unsigned short num);
/*	/*
* mqtt_subRealloc() Reallocate array from subscribe variables	* mqtt_subRealloc() Reallocate array from subscribe variables
*	*
Line 301 inline mqtt_subscr_t *mqtt_subAlloc(unsigned short num	Line 319 inline mqtt_subscr_t *mqtt_subAlloc(unsigned short num
* @num = Number of elements	* @num = Number of elements
* 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_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 */	/* SENDER FUNCTIONS */
Line 311 inline mqtt_subscr_t mqtt_subRealloc(mqtt_subscr_t	Line 337 inline mqtt_subscr_t mqtt_subRealloc(mqtt_subscr_t
*	*
* @buf = Message buffer	* @buf = Message buffer
* @csConnID = ConnectID	* @csConnID = ConnectID
* @kasec = Keep alive timeout	* @kasec = Keep alive timeout, if =0 default timeout for MQTT
* @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 378 int mqtt_msgPUBLISH(mqtt_msg_t * __restrict buf, const	Line 404 int mqtt_msgPUBLISH(mqtt_msg_t * __restrict buf, const
* @msgID = MessageID	* @msgID = MessageID
* return: -1 error or >-1 message size for send	* 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	* mqtt_msgPUBREC() Create PUBREC message
*	*
Line 386 inline int mqtt_msgPUBACK(mqtt_msg_t * __restrict buf,	Line 412 inline int mqtt_msgPUBACK(mqtt_msg_t * __restrict buf,
* @msgID = MessageID	* @msgID = MessageID
* return: -1 error or >-1 message size for send	* 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	* mqtt_msgPUBREL() Create PUBREL message
*	*
Line 394 inline int mqtt_msgPUBREC(mqtt_msg_t * __restrict buf,	Line 420 inline int mqtt_msgPUBREC(mqtt_msg_t * __restrict buf,
* @msgID = MessageID	* @msgID = MessageID
* return: -1 error or >-1 message size for send	* 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	* mqtt_msgPUBCOMP() Create PUBCOMP message
*	*
Line 402 inline int mqtt_msgPUBREL(mqtt_msg_t * __restrict buf,	Line 428 inline int mqtt_msgPUBREL(mqtt_msg_t * __restrict buf,
* @msgID = MessageID	* @msgID = MessageID
* return: -1 error or >-1 message size for send	* 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	* mqtt_msgSUBSCRIBE() Create SUBSCRIBE message
Line 507 int mqtt_readPINGRESP(mqtt_msg_t * __restrict buf);	Line 533 int mqtt_readPINGRESP(mqtt_msg_t * __restrict buf);
* @psTopic = Topic	* @psTopic = Topic
* @topicLen = Topic length	* @topicLen = Topic length
* @msgID = MessageID	* @msgID = MessageID
* @pData = Data buffer	* @pData = Data buffer, may be NULL
* @datLen = Data buffer length, if *datLen == 0 allocate memory for pData	* return: -1 error or !=-1 allocated data buffer length
* return: NULL error or !=NULL MQTT fixed header
*/	*/
struct mqtthdr mqtt_readPUBLISH(mqtt_msg_t __restrict buf, char * __restrict psTopic,	int mqtt_readPUBLISH(mqtt_msg_t * __restrict buf, char * __restrict psTopic,
int topicLen, unsigned short msgID, void __restrict pData, int *datLen);	int topicLen, unsigned short msgID, void * __restrict pData);
/*	/*
* mqtt_readPUBACK() Read PUBACK message	* mqtt_readPUBACK() Read PUBACK message
*	*

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

Removed from v.1.1.1.1.2.10
changed lines
	Added in v.1.3.4.3