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.5 and 1.1.1.1.2.16

version 1.1.1.1.2.5, 2012/01/27 15:16:40	version 1.1.1.1.2.16, 2012/06/20 08:15:12
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	Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
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 71 struct mqtthdr {	Line 71 struct mqtthdr {
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 MQTTHDR_MSGINIT(x) (assert((x)), (x)->mqtt_msg.val ^= (x)->mqtt_msg.val)
	#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 */
Line 104 struct mqtthdr {	Line 105 struct mqtthdr {
#define MQTT_QOS_EXACTLY 2 /* Exactly once, Assured delivery, =1 */	#define MQTT_QOS_EXACTLY 2 /* Exactly once, Assured delivery, =1 */
#define MQTT_QOS_RESERVED 3 /* reserved */	#define MQTT_QOS_RESERVED 3 /* reserved */

	#define MQTT_QOS_DENY 0 /* Not granted QoS for SUBACK */
	#define MQTT_QOS_PASS 2 /* Granted QoS for SUBACK */

#define MQTT_FLAG_RETAIN 1 /* This flag is only used on PUBLISH messages.	#define MQTT_FLAG_RETAIN 1 /* This flag is only used on PUBLISH messages.

When a client sends a PUBLISH to a server,	When a client sends a PUBLISH to a server,
Line 221 inline void mqtt_msgFree(mqtt_msg_t ** __restrict msg,	Line 225 inline void mqtt_msgFree(mqtt_msg_t ** __restrict msg,
* 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);	inline 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
	*/
	inline 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 234 inline int mqtt_msgRealloc(mqtt_msg_t * __restrict msg	Line 245 inline int mqtt_msgRealloc(mqtt_msg_t * __restrict msg
*/	*/
int mqtt_expandTopic(const char csInput, char __restrict psRegEx, int regexLen,	int mqtt_expandTopic(const char csInput, char __restrict psRegEx, int regexLen,
unsigned char BOL, unsigned char EOL);	unsigned char BOL, unsigned char EOL);
	/*
	* mqtt_sqlTopic() - Expanding topic to SQL search string
	*
	* @csInput = Input topic
	* @psSQL = Output to SQL search string
	* @sqlLen = Length of psSQL
	* return: -1 error, 0 changed bytes
	*/
	int mqtt_sqlTopic(const char csInput, char __restrict psSQL, int sqlLen);

/*	/*
* mqtt_encodeLen() Encode number to MQTT length field	* mqtt_encodeLen() Encode number to MQTT length field
Line 258 inline unsigned int mqtt_decodeLen(void * __restrict l	Line 278 inline unsigned int mqtt_decodeLen(void * __restrict l
*/	*/
inline char mqtt_sizeLen(unsigned int len);	inline char mqtt_sizeLen(unsigned int len);
/*	/*
* mqtt_str2sub Create MQTT subscribe variable from string(s)	* mqtt_pktLen() - Get total packet length
*	*
* @csStr = strings	* @hdr = MQTT packet header
* @strnum = number of strings elements	* return: packet length
	*/
	inline unsigned int mqtt_pktLen(struct mqtthdr * __restrict hdr);
	/*
	* mqtt_str2subs Create MQTT subscribe variable from string(s)
	*
	* @csStr = null terminated string array
	* @strnum = copy at most number of strings elements
* @qoses = QoS elements applied to subscribe variable,	* @qoses = QoS elements applied to subscribe variable,
* 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_str2sub(const char csStr, unsigned short strnum, unsigned char qoses);	inline mqtt_subscr_t mqtt_str2subs(const char *csStr, unsigned short strnum,
	unsigned char *qoses);
/*	/*
* mqtt_subFree() Free array from subscribe variables	* mqtt_subFree() Free array from subscribe variables
*	*
Line 288 inline mqtt_subscr_t *mqtt_subAlloc(unsigned short num	Line 316 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);	inline 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
	*/
	inline mqtt_subscr_t mqtt_subCopy(mqtt_subscr_t __restrict dst, mqtt_subscr_t * __restrict src);


/* SENDER FUNCTIONS */	/* SENDER FUNCTIONS */
Line 494 int mqtt_readPINGRESP(mqtt_msg_t * __restrict buf);	Line 530 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
*	*
Line 535 unsigned short mqtt_readPUBCOMP(mqtt_msg_t * __restric	Line 570 unsigned short mqtt_readPUBCOMP(mqtt_msg_t * __restric
* @buf = Message buffer	* @buf = Message buffer
* @msgID = MessageID	* @msgID = MessageID
* @subscr = Subscriptions, must be free after use with mqtt_subFree()	* @subscr = Subscriptions, must be free after use with mqtt_subFree()
* return: NULL error or !=NULL MQTT fixed header	* return: -1 error or >-1 elements into subscr
*/	*/
struct mqtthdr mqtt_readSUBSCRIBE(mqtt_msg_t __restrict buf, unsigned short *msgID,	int mqtt_readSUBSCRIBE(mqtt_msg_t * __restrict buf, unsigned short *msgID,
mqtt_subscr_t **subscr);	mqtt_subscr_t **subscr);
/*	/*
* mqtt_readSUBACK() Read SUBACK message	* mqtt_readSUBACK() Read SUBACK message
Line 554 int mqtt_readSUBACK(mqtt_msg_t * __restrict buf, unsig	Line 589 int mqtt_readSUBACK(mqtt_msg_t * __restrict buf, unsig
* @buf = Message buffer	* @buf = Message buffer
* @msgID = MessageID	* @msgID = MessageID
* @subscr = Subscriptions, must be free after use with mqtt_subFree()	* @subscr = Subscriptions, must be free after use with mqtt_subFree()
* return: NULL error or !=NULL MQTT fixed header	* return: -1 error or >-1 elements into subscr
*/	*/
struct mqtthdr mqtt_readUNSUBSCRIBE(mqtt_msg_t __restrict buf, unsigned short *msgID,	int mqtt_readUNSUBSCRIBE(mqtt_msg_t * __restrict buf, unsigned short *msgID,
mqtt_subscr_t **subscr);	mqtt_subscr_t **subscr);
/*	/*
* mqtt_readUNSUBACK() Read UNSUBACK message	* mqtt_readUNSUBACK() Read UNSUBACK message

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

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