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.4 and 1.1.1.1.2.15

version 1.1.1.1.2.4, 2012/01/27 15:15:32	version 1.1.1.1.2.15, 2012/06/11 08:37:41
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 50 SUCH DAMAGE.	Line 50 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 65529
	#define MQTT_DATA_MAX 268435455

#define MQTT_PROTO_VER 3	#define MQTT_PROTO_VER 3
#define MQTT_KEEPALIVE 10	#define MQTT_KEEPALIVE 10
	#define MQTT_DEFAULT_MSGID 0xDEBA

/* FIXED HEADER */	/* FIXED HEADER */

Line 102 struct mqtthdr {	Line 104 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 219 inline void mqtt_msgFree(mqtt_msg_t ** __restrict msg,	Line 224 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 232 inline int mqtt_msgRealloc(mqtt_msg_t * __restrict msg	Line 244 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 256 inline unsigned int mqtt_decodeLen(void * __restrict l	Line 277 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_str2subs Create MQTT subscribe variable from string(s)
*	*
* @csStr = strings	* @csStr = null terminated string array
* @strnum = number of strings elements	* @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 286 inline mqtt_subscr_t *mqtt_subAlloc(unsigned short num	Line 308 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 492 int mqtt_readPINGRESP(mqtt_msg_t * __restrict buf);	Line 522 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 533 unsigned short mqtt_readPUBCOMP(mqtt_msg_t * __restric	Line 562 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 552 int mqtt_readSUBACK(mqtt_msg_t * __restrict buf, unsig	Line 581 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.4
changed lines
	Added in v.1.1.1.1.2.15