Return to mqttapi.h CVS log

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

Annotation of libaitmqtt/inc/mqttapi.h, revision 1.1.2.6

1.1.2.4   misho       1: /*************************************************************************
                      2: * (C) 2011 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
                      3: *  by Michael Pounov <misho@openbsd-bg.org>
                      4: *
                      5: * $Author: misho $
1.1.2.6 ! misho       6: * $Id: mqttapi.h,v 1.1.2.5 2012/05/01 01:12:16 misho Exp $
1.1.2.4   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, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
                     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: */
1.1.2.1   misho      46: #ifndef __MQTTAPI_H
                     47: #define __MQTTAPI_H
                     48: 
                     49: 
1.1.2.2   misho      50: #include "aitmqtt.h"
                     51: 
                     52: 
1.1.2.5   misho      53: #ifdef API_SERVER_SIDE
1.1.2.2   misho      54: /* MQTT server structure & hooks */
                     55: 
1.1.2.6 ! misho      56: /* MQTT command callback. 1st argument is (mqtt_srv_t*) server handle, 2nd is ready length */
        !            57: typedef int (*mqtt_cb_t)(void* /*mqtt_srv_t**/, int, void *);
1.1.2.2   misho      58: typedef struct {
                     59:        mqtt_cb_t       cmds[MQTT_TYPE_MAX];
                     60: 
                     61:        int             sock;
                     62:        mqtt_msg_t      *buf;
                     63: } mqtt_srv_t;
                     64: #define mqtt_srv_setCmd(x, _cmd, _func)        (assert((x)), (x)->cmds[(_cmd)] = (_func))
                     65: #define mqtt_srv_getCmd(x, _cmd)       (assert((x)), (x)->cmds[(_cmd)])
                     66: 
                     67: 
                     68: /*
                     69:  * mqtt_srv_Init() Init server side actor
                     70:  *
                     71:  * @sock = Client socket from accept()
                     72:  * @buf = Message buffer
                     73:  * return: NULL error or !=NULL allocated server handle
                     74:  */
                     75: mqtt_srv_t *mqtt_srv_Init(int sock, mqtt_msg_t * __restrict buf);
                     76: /*
                     77:  * mqtt_srv_Fini() Finish MQTT server side support
                     78:  *
                     79:  * @psrv = Server handle
                     80:  * return: none
                     81:  */
                     82: void mqtt_srv_Fini(mqtt_srv_t ** __restrict psrv);
                     83: /*
                     84:  * mqtt_srv_Dispatch() MQTT server dispatcher
                     85:  *
                     86:  * @srv = Server handle
                     87:  * @arg = Argument pass to command callback
1.1.2.6 ! misho      88:  * @rlen = Ready bytes to parse
1.1.2.2   misho      89:  * return: -1 error or 0 ok
                     90:  */
1.1.2.6 ! misho      91: int mqtt_srv_Dispatch(mqtt_srv_t * __restrict srv, void *arg, int rlen);
1.1.2.3   misho      92: #endif
                     93: 
                     94: /*
                     95:  * mqtt_KeepAlive() - Keep Alive check routine
                     96:  *
                     97:  * @sock = connected socket
                     98:  * @ka = keep alive timeout
                     99:  * @tries = tries for receive correct ping response, usually ==1
                    100:  * return: -1 error, 0 host is alive, 1 timeout session or 2 broken session
                    101:  */
                    102: int mqtt_KeepAlive(int sock, unsigned short ka, unsigned char tries);
                    103: 
1.1.2.5   misho     104: 
1.1.2.3   misho     105: #ifdef API_CLIENT_SIDE
1.1.2.5   misho     106: /* MQTT client structure */
                    107: 
                    108: typedef struct {
                    109:        int             sock;
                    110:        mqtt_msg_t      *buf;
                    111: } mqtt_cli_t;
                    112: 
                    113: 
                    114: /*
                    115:  * mqtt_cli_Open() - Open client connection to MQTT broker
                    116:  *
                    117:  * @addr = brokers address
                    118:  * return: NULL error or !=NULL connected to broker
                    119:  */
                    120: mqtt_cli_t *mqtt_cli_Open(struct sockaddr *addr);
                    121: /*
                    122:  * mqtt_cli_Close() - Close client connection
                    123:  *
                    124:  * @cli = connected client
                    125:  * return: -1 error or 0 disconnected client and freed all resources
                    126:  */
                    127: int mqtt_cli_Close(mqtt_cli_t ** __restrict cli);
1.1.2.3   misho     128: #endif
1.1.2.2   misho     129: 
                    130: 
1.1.2.1   misho     131: #endif