Return to mqttcli.h CVS log

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

Annotation of libaitmqtt/inc/mqttcli.h, revision 1.1.2.3

1.1.2.1   misho       1: /*************************************************************************
                      2: * (C) 2022 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
                      3: *  by Michael Pounov <misho@elwix.org>
                      4: *
                      5: * $Author: misho $
1.1.2.3 ! misho       6: * $Id: mqttcli.h,v 1.1.2.2 2022/09/15 15:48:41 misho Exp $
1.1.2.1   misho       7: *
                      8: **************************************************************************
                      9: The ELWIX and AITNET software is distributed under the following
                     10: terms:
                     11: 
                     12: All of the documentation and software included in the ELWIX and AITNET
                     13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
                     14: 
                     15: Copyright 2004 - 2022
                     16:        by Michael Pounov <misho@elwix.org>.  All rights reserved.
                     17: 
                     18: Redistribution and use in source and binary forms, with or without
                     19: modification, are permitted provided that the following conditions
                     20: are met:
                     21: 1. Redistributions of source code must retain the above copyright
                     22:    notice, this list of conditions and the following disclaimer.
                     23: 2. Redistributions in binary form must reproduce the above copyright
                     24:    notice, this list of conditions and the following disclaimer in the
                     25:    documentation and/or other materials provided with the distribution.
                     26: 3. All advertising materials mentioning features or use of this software
                     27:    must display the following acknowledgement:
                     28: This product includes software developed by Michael Pounov <misho@elwix.org>
                     29: ELWIX - Embedded LightWeight unIX and its contributors.
                     30: 4. Neither the name of AITNET nor the names of its contributors
                     31:    may be used to endorse or promote products derived from this software
                     32:    without specific prior written permission.
                     33: 
                     34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
                     35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     44: SUCH DAMAGE.
                     45: */
                     46: #ifndef __MQTTCLI_H
                     47: #define __MQTTCLI_H
                     48: 
                     49: #ifdef API_CLIENT_SIDE
                     50: /* MQTT client structure */
                     51: 
                     52: typedef struct {
                     53:        int             sock;
                     54:        unsigned short  timeout;
                     55:        mqtt_msg_t      *buf;
                     56: } mqtt_cli_t;
                     57: 
                     58: 
                     59: /*
                     60:  * mqtt_cli_Open() - Open client connection to MQTT broker
                     61:  *
                     62:  * @addr = brokers address
                     63:  * @timeout = timeout
                     64:  * return: NULL error or !=NULL connected to broker
                     65:  */
                     66: mqtt_cli_t *mqtt_cli_Open(struct sockaddr *addr, unsigned short timeout);
                     67: /*
                     68:  * mqtt_cli_Close() - Close client connection
                     69:  *
                     70:  * @cli = connected client
                     71:  * return: -1 error or 0 disconnected client and freed all resources
                     72:  */
                     73: int mqtt_cli_Close(mqtt_cli_t ** __restrict cli);
                     74: 
                     75: /*
                     76:  * mqtt_cli_Subscribe() - Subscribe to broker
                     77:  *
                     78:  * @cli = connected client
                     79:  * @Topics = Topics for subscribes
                     80:  * @msgID = Message ID
                     81:  * return: NULL error or !=NULL allocated array with subscribed QoS responses, 
                     82:  *     must be e_free() result!
                     83:  */
                     84: unsigned char *mqtt_cli_Subscribe(mqtt_cli_t * __restrict cli, 
1.1.2.3 ! misho      85:                mqtt_subscr_t * __restrict Topics, unsigned short msgID);
1.1.2.1   misho      86: /*
                     87:  * mqtt_cli_Unsubscribe() - Unsubscribe from broker
                     88:  *
                     89:  * @cli = connected client
                     90:  * @Topics = Topics for unsubscribes
                     91:  * @msgID = Message ID
                     92:  * @Dup = Duplicated request
                     93:  * @QoS = Message QoS
                     94:  * return: -1 error or 0 ok
                     95:  */
                     96: int mqtt_cli_Unsubscribe(mqtt_cli_t * __restrict cli, 
1.1.2.3 ! misho      97:                mqtt_subscr_t * __restrict Topics, unsigned short msgID, 
1.1.2.1   misho      98:                unsigned char Dup, unsigned char QoS);
                     99: /*
                    100:  * mqtt_cli_Publish() - Publish message to broker
                    101:  *
                    102:  * @cli = connected client
                    103:  * @msgID = Message ID
                    104:  * @Dup = Duplicated request
                    105:  * @QoS = Message QoS
                    106:  * @Retain = Retain message
                    107:  * @csTopic = Topic
                    108:  * @pData = Data
                    109:  * @datLen = Data length
                    110:  * return: -1 error or > -1 sended bytes
                    111:  */
                    112: int mqtt_cli_Publish(mqtt_cli_t * __restrict cli, unsigned short msgID, 
                    113:                unsigned char Dup, unsigned char QoS, unsigned char Retain, 
                    114:                const char *csTopic, const void *pData, int datLen);
                    115: #endif
                    116: 
                    117: #endif