--- libaitmqtt/inc/aitmqtt.h 2022/09/13 22:20:59 1.3.4.8 +++ libaitmqtt/inc/aitmqtt.h 2022/09/14 14:32:48 1.3.4.9 @@ -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.9 2022/09/14 14:32:48 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -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,32 +400,28 @@ 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 @@ -528,7 +524,7 @@ 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 @@ -539,7 +535,7 @@ int mqtt_msgUNSUBACK(mqtt_msg_t * __restrict buf, unsi * @psWillMessage = Will Message, may be NULL if !NULL must be 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);