Return to mqttsrv.h CVS log

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

Annotation of libaitmqtt/inc/mqttsrv.h, revision 1.1.2.1

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 $
        !             6: * $Id: mqttapi.h,v 1.4 2012/07/03 08:57:04 misho Exp $
        !             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 __MQTTSRV_H
        !            47: #define __MQTTSRV_H
        !            48: 
        !            49: 
        !            50: #ifdef API_SERVER_SIDE
        !            51: /* MQTT server structure & hooks */
        !            52: 
        !            53: /* MQTT command callback. 1st argument is (mqtt_srv_t*) server handle, 2nd is ready length */
        !            54: typedef int (*mqtt_cb_t)(void* /*mqtt_srv_t**/, int, void *);
        !            55: typedef struct {
        !            56:        mqtt_cb_t       cmds[MQTT_TYPE_MAX];
        !            57: 
        !            58:        int             sock;
        !            59:        unsigned short  timeout;
        !            60:        mqtt_msg_t      *buf;
        !            61: } mqtt_srv_t;
        !            62: #define mqtt_srv_setCmd(x, _cmd, _func)        (assert((x)), (x)->cmds[(_cmd)] = (_func))
        !            63: #define mqtt_srv_getCmd(x, _cmd)       (assert((x)), (x)->cmds[(_cmd)])
        !            64: 
        !            65: 
        !            66: /*
        !            67:  * mqtt_srv_cliInit() Init MQTT server side support for clients
        !            68:  *
        !            69:  * @sock = Client socket from accept()
        !            70:  * @buf = Message buffer
        !            71:  * @timeout = timeout
        !            72:  * @nb = Non block socket
        !            73:  * return: NULL error or !=NULL allocated server handle
        !            74:  */
        !            75: mqtt_srv_t *mqtt_srv_cliInit(int sock, mqtt_msg_t * __restrict buf, 
        !            76:                unsigned short timeout, int nb);
        !            77: /*
        !            78:  * mqtt_srv_Fini() Finish MQTT server side support for clients
        !            79:  *
        !            80:  * @psrv = Server handle
        !            81:  * return: none
        !            82:  */
        !            83: void mqtt_srv_cliFini(mqtt_srv_t ** __restrict psrv);
        !            84: /*
        !            85:  * mqtt_srv_Dispatch() MQTT server dispatcher for clients
        !            86:  *
        !            87:  * @srv = Server handle
        !            88:  * @rlen = Ready bytes to parse
        !            89:  * @arg = Argument pass to command callback
        !            90:  * return: -1 error or 0 ok
        !            91:  */
        !            92: int mqtt_srv_cliDispatch(mqtt_srv_t * __restrict srv, int rlen, void *arg);
        !            93: 
        !            94: /*
        !            95:  * mqtt_srv_Create() - Create server socket
        !            96:  *
        !            97:  * @sa = Server bind address
        !            98:  * @salen = Server struct sockaddr size
        !            99:  * return: -1 error or >-1 server socket
        !           100:  */
        !           101: int mqtt_srv_Create(struct sockaddr * __restrict sa, int salen);
        !           102: /*
        !           103:  * mqtt_srv_Destroy() - Close server socket
        !           104:  *
        !           105:  * @sock = Server socket
        !           106:  * return: -1 error or 0 ok
        !           107:  */
        !           108: int mqtt_srv_Destroy(int sock);
        !           109: /*
        !           110:  * mqtt_srv_Listen() - Listen server socket
        !           111:  *
        !           112:  * @sock = Server socket
        !           113:  * @maxconn = max number of pending connections
        !           114:  * @nb = Non block socket
        !           115:  * return: -1 error or 0 ok
        !           116:  */
        !           117: int mqtt_srv_Listen(int sock, int maxconn, int nb);
        !           118: #endif
        !           119: 
        !           120: 
        !           121: #endif