--- libaitmqtt/inc/aitmqtt.h 2022/09/13 22:20:59 1.3.4.8 +++ libaitmqtt/inc/aitmqtt.h 2022/09/16 04:14:03 1.3.4.14 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitmqtt.h,v 1.3.4.8 2022/09/13 22:20:59 misho Exp $ +* $Id: aitmqtt.h,v 1.3.4.14 2022/09/16 04:14:03 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -238,7 +238,7 @@ typedef struct { /* MQTT structures */ typedef struct { - unsigned char sub_ret; + unsigned char sub_qos; mqtt_msg_t sub_topic; mqtt_msg_t sub_value; } mqtt_subscr_t; @@ -382,7 +382,7 @@ mqtt_subscr_t *mqtt_subCopy(mqtt_subscr_t * __restrict * mqtt_msgCONNECT() Create CONNECT message * * @csConnID = ConnectID - * @Version = MQTT version + * @Version = MQTT version, if =0 default version is 3.1.1 * @KASec = Keep alive timeout, if =0 default timeout for MQTT * @csUser = Username if !=NULL * @csPass = Password for Username, only if csUser is set @@ -391,7 +391,7 @@ mqtt_subscr_t *mqtt_subCopy(mqtt_subscr_t * __restrict * @ClrSess = Clear Session subscriptions after disconnect * @WillQOS = Will QOS if csWillTopic is set * @WillRetain = Will Retain Will Message if csWillTopic is set - * return: NULL error or allocated connect message + * return: NULL error or allocated CONNECT message */ mqtt_msg_t *mqtt_msgCONNECT(const char *csConnID, unsigned char Version, unsigned short KASec, const char *csUser, const char *csPass, @@ -400,37 +400,32 @@ mqtt_msg_t *mqtt_msgCONNECT(const char *csConnID, unsi /* * mqtt_msgCONNACK() Create CONNACK message * - * @buf = Message buffer * @retcode = Return code - * return: -1 error or >-1 message size for send + * return: NULL error or allocated CONNACK message */ -int mqtt_msgCONNACK(mqtt_msg_t * __restrict buf, unsigned char retcode); +mqtt_msg_t *mqtt_msgCONNACK(unsigned char retcode); /* * mqtt_msgDISCONNECT() Create DISCONNECT message * - * @buf = Message buffer - * return: -1 error or >-1 message size for send + * return: NULL error or allocated message */ -int mqtt_msgDISCONNECT(mqtt_msg_t * __restrict buf); +mqtt_msg_t *mqtt_msgDISCONNECT(); /* * mqtt_msgPINGREQ() Create PINGREQ message * - * @buf = Message buffer - * return: -1 error or >-1 message size for send + * return: NULL error or allocated message */ -int mqtt_msgPINGREQ(mqtt_msg_t * __restrict buf); +mqtt_msg_t *mqtt_msgPINGREQ(); /* * mqtt_msgPINGRESP() Create PINGRESP message * - * @buf = Message buffer - * return: -1 error or >-1 message size for send + * return: NULL error or allocated message */ -int mqtt_msgPINGRESP(mqtt_msg_t * __restrict buf); +mqtt_msg_t *mqtt_msgPINGRESP(); /* * mqtt_msgPUBLISH() Create PUBLISH message * - * @buf = Message buffer * @csTopic = Publish topic * @msgID = MessageID >0, if QOS != MQTT_QOS_ONCE * @Dup = Duplicate message @@ -438,88 +433,74 @@ int mqtt_msgPINGRESP(mqtt_msg_t * __restrict buf); * @Retain = Retain message * @pData = Publish data into topic * @datlen = Publish data length - * return: -1 error or >-1 message size for send + * return: NULL error or allocated PUBLISH message */ -int mqtt_msgPUBLISH(mqtt_msg_t * __restrict buf, const char *csTopic, - unsigned short msgID, unsigned char Dup, unsigned char QOS, +mqtt_msg_t *mqtt_msgPUBLISH(const char *csTopic, unsigned short msgID, + unsigned char Dup, unsigned char QOS, unsigned char Retain, const void *pData, int datlen); /* * mqtt_msgPUBACK() Create PUBACK message * - * @buf = Message buffer * @msgID = MessageID - * return: -1 error or >-1 message size for send + * return: NULL error or allocated PUBACK message */ -int mqtt_msgPUBACK(mqtt_msg_t * __restrict buf, unsigned short msgID); +mqtt_msg_t *mqtt_msgPUBACK(unsigned short msgID); /* * mqtt_msgPUBREC() Create PUBREC message * - * @buf = Message buffer * @msgID = MessageID - * return: -1 error or >-1 message size for send + * return: NULL error or allocated PUBREC message */ -int mqtt_msgPUBREC(mqtt_msg_t * __restrict buf, unsigned short msgID); +mqtt_msg_t *mqtt_msgPUBREC(unsigned short msgID); /* * mqtt_msgPUBREL() Create PUBREL message * - * @buf = Message buffer * @msgID = MessageID - * return: -1 error or >-1 message size for send + * return: NULL error or allocated PUBREL message */ -int mqtt_msgPUBREL(mqtt_msg_t * __restrict buf, unsigned short msgID); +mqtt_msg_t *mqtt_msgPUBREL(unsigned short msgID); /* * mqtt_msgPUBCOMP() Create PUBCOMP message * - * @buf = Message buffer * @msgID = MessageID - * return: -1 error or >-1 message size for send + * return: NULL error or allocated PUBCOMP message */ -int mqtt_msgPUBCOMP(mqtt_msg_t * __restrict buf, unsigned short msgID); +mqtt_msg_t *mqtt_msgPUBCOMP(unsigned short msgID); /* * mqtt_msgSUBSCRIBE() Create SUBSCRIBE message * - * @buf = Message buffer * @Topics = MQTT subscription topics * @msgID = MessageID - * @Dup = Duplicate message - * @QOS = QoS - * return: -1 error or >-1 message size for send + * return: NULL error or allocated SUBSCRIBE message */ -int -mqtt_msgSUBSCRIBE(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics, - unsigned short msgID, unsigned char Dup, unsigned char QOS); +mqtt_msg_t *mqtt_msgSUBSCRIBE(mqtt_subscr_t * __restrict Topics, unsigned short msgID); /* * mqtt_msgSUBACK() Create SUBACK message * - * @buf = Message buffer * @Topics = MQTT subscription topics * @msgID = MessageID - * return: -1 error or >-1 message size for send + * return: NULL error or allocated SUBACK message */ -int mqtt_msgSUBACK(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics, - unsigned short msgID); +mqtt_msg_t *mqtt_msgSUBACK(mqtt_subscr_t * __restrict Topics, unsigned short msgID); /* * mqtt_msgUNSUBSCRIBE() Create UNSUBSCRIBE message * - * @buf = Message buffer * @Topics = MQTT subscription topics * @msgID = MessageID * @Dup = Duplicate message * @QOS = QoS - * return: -1 error or >-1 message size for send + * return: NULL error or allocated UNSUBSCRIBE message */ -int -mqtt_msgUNSUBSCRIBE(mqtt_msg_t * __restrict buf, mqtt_subscr_t * __restrict Topics, +mqtt_msg_t *mqtt_msgUNSUBSCRIBE(mqtt_subscr_t * __restrict Topics, unsigned short msgID, unsigned char Dup, unsigned char QOS); /* * mqtt_msgUNSUBACK() Create UNSUBACK message * - * @buf = Message buffer * @msgID = MessageID - * return: -1 error or >-1 message size for send + * return: NULL error or allocated UNSUBACK message */ -int mqtt_msgUNSUBACK(mqtt_msg_t * __restrict buf, unsigned short msgID); +mqtt_msg_t *mqtt_msgUNSUBACK(unsigned short msgID); /*** RECEIVER FUNCTIONS ***/ @@ -528,18 +509,18 @@ int mqtt_msgUNSUBACK(mqtt_msg_t * __restrict buf, unsi * mqtt_readCONNECT() Read elements from CONNECT message * * @buf = Message buffer - * @kasec = Keep Alive in seconds for current connection + * @KASec = Keep Alive in seconds for current connection * @psConnID = ConnectID * @connLen = ConnectID length * @psUser = Username if !=NULL * @userLen = Username length * @psPass = Password for Username, only if csUser is set * @passLen = Password length - * @psWillTopic = Will Topic if !=NULL Will Flags set into message and must be free() - * @psWillMessage = Will Message, may be NULL if !NULL must be free() after use! + * @psWillTopic = Will Topic if !=NULL Will Flags set into message and must be e_free() + * @psWillMessage = Will Message, may be NULL if !NULL must be e_free() after use! * return: .reserved == 1 is error or == 0 connection flags & msg ok */ -mqtthdr_connack_t mqtt_readCONNECT(mqtt_msg_t * __restrict buf, unsigned short *kasec, +mqtthdr_connack_t mqtt_readCONNECT(mqtt_msg_t * __restrict buf, unsigned short *KASec, char * __restrict psConnID, int connLen, char * __restrict psUser, int userLen, char * __restrict psPass, int passLen, char ** __restrict psWillTopic, char ** __restrict psWillMessage); @@ -628,7 +609,7 @@ int mqtt_readSUBSCRIBE(mqtt_msg_t * __restrict buf, un * * @buf = Message buffer * @msgID = MessageID - * @subqos = Subscribes QoS, must be free after use with free() + * @subqos = Subscribes QoS, must be free after use with e_free() * return: -1 error or >-1 readed subscribes QoS elements */ int mqtt_readSUBACK(mqtt_msg_t * __restrict buf, unsigned short *msgID, unsigned char **subqos);