Annotation of libaitmqtt/inc/mqttapi.h, revision 1.2
1.2 ! misho 1: /*************************************************************************
! 2: * (C) 2011 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
! 3: * by Michael Pounov <misho@openbsd-bg.org>
! 4: *
! 5: * $Author: misho $
! 6: * $Id: mqttapi.h,v 1.1.2.11 2012/06/19 15:55:00 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, 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: */
! 46: #ifndef __MQTTAPI_H
! 47: #define __MQTTAPI_H
! 48:
! 49:
! 50: #include "aitmqtt.h"
! 51:
! 52:
! 53: #ifdef API_SERVER_SIDE
! 54: /* MQTT server structure & hooks */
! 55:
! 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 *);
! 58: typedef struct {
! 59: mqtt_cb_t cmds[MQTT_TYPE_MAX];
! 60:
! 61: int sock;
! 62: unsigned short timeout;
! 63: mqtt_msg_t *buf;
! 64: } mqtt_srv_t;
! 65: #define mqtt_srv_setCmd(x, _cmd, _func) (assert((x)), (x)->cmds[(_cmd)] = (_func))
! 66: #define mqtt_srv_getCmd(x, _cmd) (assert((x)), (x)->cmds[(_cmd)])
! 67:
! 68:
! 69: /*
! 70: * mqtt_srv_Init() Init server side actor
! 71: *
! 72: * @sock = Client socket from accept()
! 73: * @buf = Message buffer
! 74: * @timeout = timeout
! 75: * return: NULL error or !=NULL allocated server handle
! 76: */
! 77: mqtt_srv_t *mqtt_srv_Init(int sock, mqtt_msg_t * __restrict buf, unsigned short timeout);
! 78: /*
! 79: * mqtt_srv_Fini() Finish MQTT server side support
! 80: *
! 81: * @psrv = Server handle
! 82: * return: none
! 83: */
! 84: void mqtt_srv_Fini(mqtt_srv_t ** __restrict psrv);
! 85: /*
! 86: * mqtt_srv_Dispatch() MQTT server dispatcher
! 87: *
! 88: * @srv = Server handle
! 89: * @rlen = Ready bytes to parse
! 90: * @arg = Argument pass to command callback
! 91: * return: -1 error or 0 ok
! 92: */
! 93: int mqtt_srv_Dispatch(mqtt_srv_t * __restrict srv, int rlen, void *arg);
! 94: #endif
! 95:
! 96: /*
! 97: * mqtt_KeepAlive() - Keep Alive check routine
! 98: *
! 99: * @sock = connected socket
! 100: * @ka = keep alive timeout
! 101: * @tries = tries for receive correct ping response, usually ==1
! 102: * return: -1 error, 0 host is alive, 1 timeout session or 2 broken session
! 103: */
! 104: int mqtt_KeepAlive(int sock, unsigned short ka, unsigned char tries);
! 105:
! 106:
! 107: #ifdef API_CLIENT_SIDE
! 108: /* MQTT client structure */
! 109:
! 110: typedef struct {
! 111: int sock;
! 112: unsigned short timeout;
! 113: mqtt_msg_t *buf;
! 114: } mqtt_cli_t;
! 115:
! 116:
! 117: /*
! 118: * mqtt_cli_Open() - Open client connection to MQTT broker
! 119: *
! 120: * @addr = brokers address
! 121: * @timeout = timeout
! 122: * return: NULL error or !=NULL connected to broker
! 123: */
! 124: mqtt_cli_t *mqtt_cli_Open(struct sockaddr *addr, unsigned short timeout);
! 125: /*
! 126: * mqtt_cli_Close() - Close client connection
! 127: *
! 128: * @cli = connected client
! 129: * return: -1 error or 0 disconnected client and freed all resources
! 130: */
! 131: int mqtt_cli_Close(mqtt_cli_t ** __restrict cli);
! 132:
! 133: /*
! 134: * mqtt_cli_Subscribe() - Subscribe to broker
! 135: *
! 136: * @cli = connected client
! 137: * @Topics = Topics for subscribes
! 138: * @msgID = Message ID
! 139: * @Dup = Duplicated request
! 140: * @QoS = Message QoS
! 141: * return: NULL error or !=NULL allocated array with subscribed QoS responses,
! 142: * must be free() result!
! 143: */
! 144: unsigned char *mqtt_cli_Subscribe(mqtt_cli_t * __restrict cli,
! 145: mqtt_subscr_t * __restrict Topics, unsigned short msgID,
! 146: unsigned char Dup, unsigned char QoS);
! 147: /*
! 148: * mqtt_cli_Unsubscribe() - Unsubscribe from broker
! 149: *
! 150: * @cli = connected client
! 151: * @Topics = Topics for unsubscribes
! 152: * @msgID = Message ID
! 153: * @Dup = Duplicated request
! 154: * @QoS = Message QoS
! 155: * return: -1 error or 0 ok
! 156: */
! 157: int mqtt_cli_Unsubscribe(mqtt_cli_t * __restrict cli,
! 158: mqtt_subscr_t * __restrict Topics, unsigned short msgID,
! 159: unsigned char Dup, unsigned char QoS);
! 160: /*
! 161: * mqtt_cli_Publish() - Publish message to broker
! 162: *
! 163: * @cli = connected client
! 164: * @msgID = Message ID
! 165: * @Dup = Duplicated request
! 166: * @QoS = Message QoS
! 167: * @Retain = Retain message
! 168: * @csTopic = Topic
! 169: * @pData = Data
! 170: * @datLen = Data length
! 171: * return: -1 error or > -1 sended bytes
! 172: */
! 173: int mqtt_cli_Publish(mqtt_cli_t * __restrict cli, unsigned short msgID,
! 174: unsigned char Dup, unsigned char QoS, unsigned char Retain,
! 175: const char *csTopic, const void *pData, int datLen);
! 176: #endif
! 177:
! 178:
! 179: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to mqttapi.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitmqtt / inc