--- libaitmqtt/inc/Attic/mqttcli.h 2022/09/15 15:04:44 1.1 +++ libaitmqtt/inc/Attic/mqttcli.h 2022/09/16 04:18:17 1.1.2.3 @@ -0,0 +1,117 @@ +/************************************************************************* +* (C) 2022 AITNET ltd - Sofia/Bulgaria - +* by Michael Pounov +* +* $Author: misho $ +* $Id: mqttcli.h,v 1.1.2.3 2022/09/16 04:18:17 misho Exp $ +* +************************************************************************** +The ELWIX and AITNET software is distributed under the following +terms: + +All of the documentation and software included in the ELWIX and AITNET +Releases is copyrighted by ELWIX - Sofia/Bulgaria + +Copyright 2004 - 2022 + by Michael Pounov . All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. +3. All advertising materials mentioning features or use of this software + must display the following acknowledgement: +This product includes software developed by Michael Pounov +ELWIX - Embedded LightWeight unIX and its contributors. +4. Neither the name of AITNET nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGE. +*/ +#ifndef __MQTTCLI_H +#define __MQTTCLI_H + +#ifdef API_CLIENT_SIDE +/* MQTT client structure */ + +typedef struct { + int sock; + unsigned short timeout; + mqtt_msg_t *buf; +} mqtt_cli_t; + + +/* + * mqtt_cli_Open() - Open client connection to MQTT broker + * + * @addr = brokers address + * @timeout = timeout + * return: NULL error or !=NULL connected to broker + */ +mqtt_cli_t *mqtt_cli_Open(struct sockaddr *addr, unsigned short timeout); +/* + * mqtt_cli_Close() - Close client connection + * + * @cli = connected client + * return: -1 error or 0 disconnected client and freed all resources + */ +int mqtt_cli_Close(mqtt_cli_t ** __restrict cli); + +/* + * mqtt_cli_Subscribe() - Subscribe to broker + * + * @cli = connected client + * @Topics = Topics for subscribes + * @msgID = Message ID + * return: NULL error or !=NULL allocated array with subscribed QoS responses, + * must be e_free() result! + */ +unsigned char *mqtt_cli_Subscribe(mqtt_cli_t * __restrict cli, + mqtt_subscr_t * __restrict Topics, unsigned short msgID); +/* + * mqtt_cli_Unsubscribe() - Unsubscribe from broker + * + * @cli = connected client + * @Topics = Topics for unsubscribes + * @msgID = Message ID + * @Dup = Duplicated request + * @QoS = Message QoS + * return: -1 error or 0 ok + */ +int mqtt_cli_Unsubscribe(mqtt_cli_t * __restrict cli, + mqtt_subscr_t * __restrict Topics, unsigned short msgID, + unsigned char Dup, unsigned char QoS); +/* + * mqtt_cli_Publish() - Publish message to broker + * + * @cli = connected client + * @msgID = Message ID + * @Dup = Duplicated request + * @QoS = Message QoS + * @Retain = Retain message + * @csTopic = Topic + * @pData = Data + * @datLen = Data length + * return: -1 error or > -1 sended bytes + */ +int mqtt_cli_Publish(mqtt_cli_t * __restrict cli, unsigned short msgID, + unsigned char Dup, unsigned char QoS, unsigned char Retain, + const char *csTopic, const void *pData, int datLen); +#endif + +#endif