Return to aitmqtt.h CVS log

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

add file with conn*

#ifndef __AITMQTT_H
#define __AITMQTT_H


#define MQTT_DATA_MAX		268435455
#define MQTT_CONN_STR		"MQIsdp"
#define MQTT_PROTO_VER		3
#define MQTT_KEEPALIVE		10

/* FIXED HEADER */

struct mqtthdr {
	struct {
		unsigned char	retain:1, 
				qos:2,
				dup:1,
				type:4;
	} mqtt_msg;
	unsigned char		mqtt_len[1];	/* may be grow to 4 bytes */
} __packed;

#define MQTT_TYPE_UNKNOWN	0	/* reserved */
#define MQTT_TYPE_CONNECT	1	/* client request to connect to server */
#define MQTT_TYPE_CONNACK	2	/* connect acknowledgment */
#define MQTT_TYPE_PUBLISH	3	/* publish message */
#define MQTT_TYPE_PUBACK	4	/* publish acknowledgment */
#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_PUBCOMP	7	/* publish complete (assured delivery part 3) */
#define MQTT_TYPE_SUBSCRIBE	8	/* client subscribe request */
#define MQTT_TYPE_SUBACK	9	/* subscribe acknowledgment */
#define MQTT_TYPE_UNSUBSCRIBE	10	/* client unsubscribe request */
#define MQTT_TYPE_UNSUBACK	11	/* unsubscribe acknowledgment */
#define MQTT_TYPE_PINGREQ	12	/* PING request */
#define MQTT_TYPE_PINGRESP	13	/* PING response */
#define MQTT_TYPE_DISCONNECT	14	/* client is disconnecting */
#define MQTT_TYPE_RESERVED	15	/* reserved */

#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. 
					   This applies to messages where the value of QoS is greater than 
					   zero (0), and an acknowledgment is required. 
					   When the DUP bit is set, the variable header includes a Message ID.

					   The recipient should treat this flag as a hint as to whether 
					   the message may have been previously received. 
					   It should not be relied on to detect duplicates. */

#define MQTT_QOS_ONCE		0	/* At most once, Fire and Forget, <=1 */
#define MQTT_QOS_ACK		1	/* At least once, Acknowledged delivery, >=1 */
#define MQTT_QOS_EXACTLY	2	/* Exactly once, Assured delivery, =1 */
#define MQTT_QOS_RESERVED	3	/* reserved */

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

					   When a client sends a PUBLISH to a server, 
					   if the Retain flag is set (1), 
					   the server should hold on to the message after it has been 
					   delivered to the current subscribers.
					   When a new subscription is established on a topic, 
					   the last retained message on that topic should be sent to 
					   the subscriber with the Retain flag set.
					   If there is no retained message, nothing is sent
					   This is useful where publishers send messages on a 
					   "report by exception" basis, where it might be some time between messages. 
					   This allows new subscribers to instantly receive data with the retained, 
					   or Last Known Good, value.

					   When a server sends a PUBLISH to a client as a result of 
					   a subscription that already existed when the original PUBLISH arrived, 
					   the Retain flag should not be set, regardless of the Retain flag 
					   of the original PUBLISH. This allows a client to distinguish messages 
					   that are being received because they were retained and those 
					   that are being received "live".

					   Retained messages should be kept over restarts of the server.
					   A server may delete a retained message if it receives a message 
					   with a zero-length payload and the Retain flag set on the same topic. */

/* VARIABLE HEADERS */

#define MQTT_RETCODE_ACCEPTED		0
#define MQTT_RETCODE_REFUSE_VER		1
#define MQTT_RETCODE_REFUSE_ID		2
#define MQTT_RETCODE_REFUSE_UNAVAIL	3
#define MQTT_RETCODE_REFUSE_USERPASS	4
#define MQTT_RETCODE_DENIED		5


typedef union {
	struct {
		unsigned short	m:8,
				l:8;
	} sb;
	unsigned short	val;
} mqtt_v_t;

typedef struct {
	mqtt_v_t	var_sb;
	unsigned char	var_data[0];
} __packed mqtthdr_var_t;
#define MQTTHDR_VAR_SIZEOF(x)		(assert((x)), sizeof(mqtt_v_t) + ntohs((x)->var_sb.val))

typedef unsigned char mqtthdr_protover_t;
typedef unsigned char mqtthdr_retcode_t;

typedef struct {
	unsigned char	reserved:1,
			clean_sess:1,
			will_flg:1,
			will_qos:2,
			will_retain:1,
			password:1,
			username:1;
} __packed mqtthdr_connflgs_t;


/* MQTT Message buffer */

typedef struct {
	void		*msg_base;
	unsigned short	msg_len;
} mqtt_msg_t;


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


/*
 * mqtt_msgAlloc() Allocate memory for MQTT Message
 * @len = >0 Allocate buffer with length
 * return: NULL error or Message, after use must call mqtt_msgFree() with all!=0
 */
inline mqtt_msg_t *mqtt_msgAlloc(unsigned short len);
/*
 * mqtt_msgFree() Free MQTT message
 * @msg = Message buffer
 * @all = !=0 Destroy entire message, if MQTT Message allocated with mqtt_msgAlloc()
 * return: none
 */
inline void mqtt_msgFree(mqtt_msg_t ** __restrict msg, int all);
/*
 * mqtt_msgRealloc() Reallocate MQTT message buffer
 * @msg = MQTT message
 * @len = new length
 * return: -1 error or >-1 old buffer length
 */
inline int mqtt_msgRealloc(mqtt_msg_t * __restrict msg, unsigned short len);

/*
 * mqtt_encodeLen() Encode number to MQTT length field
 * @num = number for encode
 * return: -1 error or >-1 length
 */
inline unsigned int mqtt_encodeLen(unsigned int num);
/*
 * mqtt_decodeLen() Decode length from MQTT packet
 * @len = length
 * @n = sizeof bytes, if !=NULL
 * return: -1 error, >-1 length of message
 */
inline unsigned int mqtt_decodeLen(unsigned int len, char *n);
/*
 * mqtt_sizeLen Return sizeof len field
 * @len = length
 * return: -1 error, >-1 sizeof len in bytes
 */
inline char mqtt_sizeLen(unsigned int len);
/*
 * mqtt_str2var Create MQTT variable from string
 * @csStr = string
 * @strLen = string length
 * return: NULL error or != ok variable, must be free after use!
 */
inline mqtthdr_var_t *mqtt_str2var(const unsigned char *csStr, unsigned short strLen);

/*
 * mqtt_msgCONNECT() Create CONNECT message
 *
 * @buf = Message buffer
 * @csConnID = ConnectID
 * @csUser = Username if !=NULL
 * @csPass = Password for Username, only if csUser is set
 * @csWillTopic = Will Topic if !=NULL Will Flags set into message
 * @csWillMessage = Will Message, may be NULL
 * @ClrSess = Clear Session subscriptions after disconnect
 * @WillQOS = Will QOS if csWillTopic is set
 * @WillRetain = Will Retain Will Message if csWillTopic is set
 * return: -1 error or >-1 message size for send
 */
int mqtt_msgCONNECT(mqtt_msg_t * __restrict buf, const char *csConnID, 
		const char *csUser, const char *csPass, 
		const char *csWillTopic, const char *csWillMessage, 
		char ClrSess, char WillQOS, char WillRetain);


#endif