Annotation of libaitmqtt/inc/mqttapi.h, revision 1.2.4.1
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 $
1.2.4.1 ! misho 6: * $Id: mqttapi.h,v 1.2 2012/06/20 15:02:23 misho Exp $
1.2 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: */
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: /*
1.2.4.1 ! misho 70: * mqtt_srv_cliInit() Init MQTT server side support for clients
1.2 misho 71: *
72: * @sock = Client socket from accept()
73: * @buf = Message buffer
74: * @timeout = timeout
75: * return: NULL error or !=NULL allocated server handle
76: */
1.2.4.1 ! misho 77: mqtt_srv_t *mqtt_srv_cliInit(int sock, mqtt_msg_t * __restrict buf, unsigned short timeout);
1.2 misho 78: /*
1.2.4.1 ! misho 79: * mqtt_srv_Fini() Finish MQTT server side support for clients
1.2 misho 80: *
81: * @psrv = Server handle
82: * return: none
83: */
1.2.4.1 ! misho 84: void mqtt_srv_cliFini(mqtt_srv_t ** __restrict psrv);
1.2 misho 85: /*
1.2.4.1 ! misho 86: * mqtt_srv_Dispatch() MQTT server dispatcher for clients
1.2 misho 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: */
1.2.4.1 ! misho 93: int mqtt_srv_cliDispatch(mqtt_srv_t * __restrict srv, int rlen, void *arg);
! 94:
! 95: /*
! 96: * mqtt_srv_Create() - Create server socket
! 97: *
! 98: * @sa = Server bind address
! 99: * @salen = Server struct sockaddr size
! 100: * return: -1 error or >-1 server socket
! 101: */
! 102: int mqtt_srv_Create(struct sockaddr * __restrict sa, int salen);
! 103: /*
! 104: * mqtt_srv_Destroy() - Close server socket
! 105: *
! 106: * @sock = Server socket
! 107: * return: -1 error or 0 ok
! 108: */
! 109: int mqtt_srv_Destroy(int sock);
! 110: /*
! 111: * mqtt_srv_Listen() - Listen server socket
! 112: *
! 113: * @sock = Server socket
! 114: * @maxconn = max number of pending connections
! 115: * @nb = Non block socket
! 116: * return: -1 error or 0 ok
! 117: */
! 118: int mqtt_srv_Listen(int sock, int maxconn, int nb);
1.2 misho 119: #endif
120:
121: /*
122: * mqtt_KeepAlive() - Keep Alive check routine
123: *
124: * @sock = connected socket
125: * @ka = keep alive timeout
126: * @tries = tries for receive correct ping response, usually ==1
127: * return: -1 error, 0 host is alive, 1 timeout session or 2 broken session
128: */
129: int mqtt_KeepAlive(int sock, unsigned short ka, unsigned char tries);
130:
131:
132: #ifdef API_CLIENT_SIDE
133: /* MQTT client structure */
134:
135: typedef struct {
136: int sock;
137: unsigned short timeout;
138: mqtt_msg_t *buf;
139: } mqtt_cli_t;
140:
141:
142: /*
143: * mqtt_cli_Open() - Open client connection to MQTT broker
144: *
145: * @addr = brokers address
146: * @timeout = timeout
147: * return: NULL error or !=NULL connected to broker
148: */
149: mqtt_cli_t *mqtt_cli_Open(struct sockaddr *addr, unsigned short timeout);
150: /*
151: * mqtt_cli_Close() - Close client connection
152: *
153: * @cli = connected client
154: * return: -1 error or 0 disconnected client and freed all resources
155: */
156: int mqtt_cli_Close(mqtt_cli_t ** __restrict cli);
157:
158: /*
159: * mqtt_cli_Subscribe() - Subscribe to broker
160: *
161: * @cli = connected client
162: * @Topics = Topics for subscribes
163: * @msgID = Message ID
164: * @Dup = Duplicated request
165: * @QoS = Message QoS
166: * return: NULL error or !=NULL allocated array with subscribed QoS responses,
167: * must be free() result!
168: */
169: unsigned char *mqtt_cli_Subscribe(mqtt_cli_t * __restrict cli,
170: mqtt_subscr_t * __restrict Topics, unsigned short msgID,
171: unsigned char Dup, unsigned char QoS);
172: /*
173: * mqtt_cli_Unsubscribe() - Unsubscribe from broker
174: *
175: * @cli = connected client
176: * @Topics = Topics for unsubscribes
177: * @msgID = Message ID
178: * @Dup = Duplicated request
179: * @QoS = Message QoS
180: * return: -1 error or 0 ok
181: */
182: int mqtt_cli_Unsubscribe(mqtt_cli_t * __restrict cli,
183: mqtt_subscr_t * __restrict Topics, unsigned short msgID,
184: unsigned char Dup, unsigned char QoS);
185: /*
186: * mqtt_cli_Publish() - Publish message to broker
187: *
188: * @cli = connected client
189: * @msgID = Message ID
190: * @Dup = Duplicated request
191: * @QoS = Message QoS
192: * @Retain = Retain message
193: * @csTopic = Topic
194: * @pData = Data
195: * @datLen = Data length
196: * return: -1 error or > -1 sended bytes
197: */
198: int mqtt_cli_Publish(mqtt_cli_t * __restrict cli, unsigned short msgID,
199: unsigned char Dup, unsigned char QoS, unsigned char Retain,
200: const char *csTopic, const void *pData, int datLen);
201: #endif
202:
203:
204: #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