eric liang / MQTT

MQTT lib for WISEAgent

Dependencies:   FP MQTTPacket

Dependents:   MQTT_G_SENSOR

Fork of MQTT by MQTT

MQTTAsync.h@46:55dd947a124e, 2015-08-12 (annotated)

Committer:
ericliang
Date:
Wed Aug 12 02:41:58 2015 +0000
Revision:
46:55dd947a124e
Parent:
45:bd3567993b26 
MQTT lib

Who changed what in which revision?

UserRevisionLine numberNew contents of line
icraggs 20:cad3d54d7ecf 1 /*******************************************************************************
icraggs 20:cad3d54d7ecf 2 * Copyright (c) 2014 IBM Corp.
icraggs 20:cad3d54d7ecf 3 *
icraggs 20:cad3d54d7ecf 4 * All rights reserved. This program and the accompanying materials
icraggs 20:cad3d54d7ecf 5 * are made available under the terms of the Eclipse Public License v1.0
icraggs 20:cad3d54d7ecf 6 * and Eclipse Distribution License v1.0 which accompany this distribution.
icraggs 20:cad3d54d7ecf 7 *
icraggs 20:cad3d54d7ecf 8 * The Eclipse Public License is available at
icraggs 20:cad3d54d7ecf 9 * http://www.eclipse.org/legal/epl-v10.html
icraggs 20:cad3d54d7ecf 10 * and the Eclipse Distribution License is available at
icraggs 20:cad3d54d7ecf 11 * http://www.eclipse.org/org/documents/edl-v10.php.
icraggs 20:cad3d54d7ecf 12 *
icraggs 20:cad3d54d7ecf 13 * Contributors:
icraggs 20:cad3d54d7ecf 14 * Ian Craggs - initial API and implementation and/or initial documentation
icraggs 20:cad3d54d7ecf 15 *******************************************************************************/
icraggs 20:cad3d54d7ecf 16
icraggs 21:e918525e529d 17 #if !defined(MQTTASYNC_H)
icraggs 21:e918525e529d 18 #define MQTTASYNC_H
icraggs 20:cad3d54d7ecf 19
icraggs 20:cad3d54d7ecf 20 #include "FP.h"
icraggs 20:cad3d54d7ecf 21 #include "MQTTPacket.h"
icraggs 20:cad3d54d7ecf 22 #include "stdio.h"
icraggs 20:cad3d54d7ecf 23
ericliang 45:bd3567993b26 24
ericliang 45:bd3567993b26 25
icraggs 20:cad3d54d7ecf 26 namespace MQTT
icraggs 20:cad3d54d7ecf 27 {
icraggs 20:cad3d54d7ecf 28
icraggs 20:cad3d54d7ecf 29
icraggs 20:cad3d54d7ecf 30 enum QoS { QOS0, QOS1, QOS2 };
icraggs 20:cad3d54d7ecf 31
icraggs 20:cad3d54d7ecf 32
icraggs 20:cad3d54d7ecf 33 struct Message
icraggs 20:cad3d54d7ecf 34 {
icraggs 20:cad3d54d7ecf 35 enum QoS qos;
icraggs 20:cad3d54d7ecf 36 bool retained;
icraggs 20:cad3d54d7ecf 37 bool dup;
icraggs 20:cad3d54d7ecf 38 unsigned short id;
icraggs 20:cad3d54d7ecf 39 void *payload;
icraggs 20:cad3d54d7ecf 40 size_t payloadlen;
icraggs 20:cad3d54d7ecf 41 };
icraggs 20:cad3d54d7ecf 42
icraggs 20:cad3d54d7ecf 43
icraggs 20:cad3d54d7ecf 44 class PacketId
icraggs 20:cad3d54d7ecf 45 {
icraggs 20:cad3d54d7ecf 46 public:
icraggs 20:cad3d54d7ecf 47 PacketId();
icraggs 20:cad3d54d7ecf 48
icraggs 20:cad3d54d7ecf 49 int getNext();
icraggs 20:cad3d54d7ecf 50
icraggs 20:cad3d54d7ecf 51 private:
icraggs 20:cad3d54d7ecf 52 static const int MAX_PACKET_ID = 65535;
icraggs 20:cad3d54d7ecf 53 int next;
icraggs 20:cad3d54d7ecf 54 };
icraggs 20:cad3d54d7ecf 55
icraggs 20:cad3d54d7ecf 56 typedef void (*messageHandler)(Message*);
icraggs 20:cad3d54d7ecf 57
icraggs 20:cad3d54d7ecf 58 typedef struct limits
icraggs 20:cad3d54d7ecf 59 {
icraggs 20:cad3d54d7ecf 60 int MAX_MQTT_PACKET_SIZE; //
icraggs 20:cad3d54d7ecf 61 int MAX_MESSAGE_HANDLERS; // each subscription requires a message handler
icraggs 20:cad3d54d7ecf 62 int MAX_CONCURRENT_OPERATIONS; // each command which runs concurrently can have a result handler, when we are in multi-threaded mode
icraggs 21:e918525e529d 63 int command_timeout_ms;
icraggs 20:cad3d54d7ecf 64
icraggs 20:cad3d54d7ecf 65 limits()
icraggs 20:cad3d54d7ecf 66 {
ericliang 45:bd3567993b26 67 MAX_MQTT_PACKET_SIZE = ADV_MAX_PACKET_SIZE;
icraggs 20:cad3d54d7ecf 68 MAX_MESSAGE_HANDLERS = 5;
icraggs 20:cad3d54d7ecf 69 MAX_CONCURRENT_OPERATIONS = 1; // 1 indicates single-threaded mode - set to >1 for multithreaded mode
icraggs 21:e918525e529d 70 command_timeout_ms = 30000;
icraggs 20:cad3d54d7ecf 71 }
icraggs 20:cad3d54d7ecf 72 } Limits;
icraggs 20:cad3d54d7ecf 73
icraggs 22:aadb79d29330 74
icraggs 22:aadb79d29330 75 /**
icraggs 22:aadb79d29330 76 * @class Async
icraggs 22:aadb79d29330 77 * @brief non-blocking, threaded MQTT client API
icraggs 22:aadb79d29330 78 * @param Network a network class which supports send, receive
icraggs 22:aadb79d29330 79 * @param Timer a timer class with the methods:
icraggs 22:aadb79d29330 80 */
icraggs 21:e918525e529d 81 template<class Network, class Timer, class Thread, class Mutex> class Async
icraggs 20:cad3d54d7ecf 82 {
icraggs 20:cad3d54d7ecf 83
icraggs 20:cad3d54d7ecf 84 public:
icraggs 20:cad3d54d7ecf 85
icraggs 20:cad3d54d7ecf 86 struct Result
icraggs 20:cad3d54d7ecf 87 {
icraggs 20:cad3d54d7ecf 88 /* success or failure result data */
icraggs 21:e918525e529d 89 Async<Network, Timer, Thread, Mutex>* client;
icraggs 21:e918525e529d 90 int rc;
icraggs 20:cad3d54d7ecf 91 };
icraggs 20:cad3d54d7ecf 92
icraggs 20:cad3d54d7ecf 93 typedef void (*resultHandler)(Result*);
icraggs 20:cad3d54d7ecf 94
icraggs 21:e918525e529d 95 Async(Network* network, const Limits limits = Limits());
icraggs 21:e918525e529d 96
icraggs 21:e918525e529d 97 typedef struct
icraggs 21:e918525e529d 98 {
icraggs 21:e918525e529d 99 Async* client;
icraggs 21:e918525e529d 100 Network* network;
icraggs 21:e918525e529d 101 } connectionLostInfo;
icraggs 21:e918525e529d 102
icraggs 21:e918525e529d 103 typedef int (*connectionLostHandlers)(connectionLostInfo*);
icraggs 21:e918525e529d 104
icraggs 21:e918525e529d 105 /** Set the connection lost callback - called whenever the connection is lost and we should be connected
icraggs 21:e918525e529d 106 * @param clh - pointer to the callback function
icraggs 21:e918525e529d 107 */
icraggs 21:e918525e529d 108 void setConnectionLostHandler(connectionLostHandlers clh)
icraggs 21:e918525e529d 109 {
icraggs 21:e918525e529d 110 connectionLostHandler.attach(clh);
icraggs 21:e918525e529d 111 }
icraggs 21:e918525e529d 112
icraggs 21:e918525e529d 113 /** Set the default message handling callback - used for any message which does not match a subscription message handler
icraggs 21:e918525e529d 114 * @param mh - pointer to the callback function
icraggs 21:e918525e529d 115 */
icraggs 21:e918525e529d 116 void setDefaultMessageHandler(messageHandler mh)
icraggs 21:e918525e529d 117 {
icraggs 21:e918525e529d 118 defaultMessageHandler.attach(mh);
icraggs 21:e918525e529d 119 }
icraggs 20:cad3d54d7ecf 120
icraggs 21:e918525e529d 121 int connect(resultHandler fn, MQTTPacket_connectData* options = 0);
icraggs 20:cad3d54d7ecf 122
icraggs 20:cad3d54d7ecf 123 template<class T>
icraggs 21:e918525e529d 124 int connect(void(T::*method)(Result *), MQTTPacket_connectData* options = 0, T *item = 0); // alternative to pass in pointer to member function
icraggs 20:cad3d54d7ecf 125
icraggs 21:e918525e529d 126 int publish(resultHandler rh, const char* topic, Message* message);
icraggs 20:cad3d54d7ecf 127
icraggs 21:e918525e529d 128 int subscribe(resultHandler rh, const char* topicFilter, enum QoS qos, messageHandler mh);
icraggs 20:cad3d54d7ecf 129
icraggs 21:e918525e529d 130 int unsubscribe(resultHandler rh, const char* topicFilter);
icraggs 20:cad3d54d7ecf 131
icraggs 21:e918525e529d 132 int disconnect(resultHandler rh);
icraggs 20:cad3d54d7ecf 133
icraggs 20:cad3d54d7ecf 134 private:
icraggs 20:cad3d54d7ecf 135
icraggs 20:cad3d54d7ecf 136 void run(void const *argument);
icraggs 20:cad3d54d7ecf 137 int cycle(int timeout);
icraggs 20:cad3d54d7ecf 138 int waitfor(int packet_type, Timer& atimer);
icraggs 20:cad3d54d7ecf 139 int keepalive();
icraggs 20:cad3d54d7ecf 140 int findFreeOperation();
icraggs 20:cad3d54d7ecf 141
icraggs 20:cad3d54d7ecf 142 int decodePacket(int* value, int timeout);
icraggs 20:cad3d54d7ecf 143 int readPacket(int timeout);
icraggs 20:cad3d54d7ecf 144 int sendPacket(int length, int timeout);
icraggs 20:cad3d54d7ecf 145 int deliverMessage(MQTTString* topic, Message* message);
icraggs 20:cad3d54d7ecf 146
icraggs 20:cad3d54d7ecf 147 Thread* thread;
icraggs 20:cad3d54d7ecf 148 Network* ipstack;
icraggs 20:cad3d54d7ecf 149
icraggs 20:cad3d54d7ecf 150 Limits limits;
icraggs 20:cad3d54d7ecf 151
icraggs 20:cad3d54d7ecf 152 char* buf;
icraggs 20:cad3d54d7ecf 153 char* readbuf;
icraggs 20:cad3d54d7ecf 154
icraggs 20:cad3d54d7ecf 155 Timer ping_timer, connect_timer;
icraggs 20:cad3d54d7ecf 156 unsigned int keepAliveInterval;
icraggs 20:cad3d54d7ecf 157 bool ping_outstanding;
icraggs 20:cad3d54d7ecf 158
icraggs 20:cad3d54d7ecf 159 PacketId packetid;
icraggs 20:cad3d54d7ecf 160
icraggs 20:cad3d54d7ecf 161 typedef FP<void, Result*> resultHandlerFP;
icraggs 20:cad3d54d7ecf 162 resultHandlerFP connectHandler;
icraggs 20:cad3d54d7ecf 163
icraggs 20:cad3d54d7ecf 164 typedef FP<void, Message*> messageHandlerFP;
icraggs 20:cad3d54d7ecf 165 struct MessageHandlers
icraggs 20:cad3d54d7ecf 166 {
icraggs 20:cad3d54d7ecf 167 const char* topic;
icraggs 20:cad3d54d7ecf 168 messageHandlerFP fp;
icraggs 20:cad3d54d7ecf 169 } *messageHandlers; // Message handlers are indexed by subscription topic
icraggs 20:cad3d54d7ecf 170
icraggs 20:cad3d54d7ecf 171 // how many concurrent operations should we allow? Each one will require a function pointer
icraggs 20:cad3d54d7ecf 172 struct Operations
icraggs 20:cad3d54d7ecf 173 {
icraggs 20:cad3d54d7ecf 174 unsigned short id;
icraggs 20:cad3d54d7ecf 175 resultHandlerFP fp;
icraggs 20:cad3d54d7ecf 176 const char* topic; // if this is a publish, store topic name in case republishing is required
icraggs 20:cad3d54d7ecf 177 Message* message; // for publish,
icraggs 20:cad3d54d7ecf 178 Timer timer; // to check if the command has timed out
icraggs 20:cad3d54d7ecf 179 } *operations; // result handlers are indexed by packet ids
icraggs 20:cad3d54d7ecf 180
icraggs 20:cad3d54d7ecf 181 static void threadfn(void* arg);
icraggs 21:e918525e529d 182
icraggs 21:e918525e529d 183 messageHandlerFP defaultMessageHandler;
icraggs 21:e918525e529d 184
icraggs 21:e918525e529d 185 typedef FP<int, connectionLostInfo*> connectionLostFP;
icraggs 21:e918525e529d 186
icraggs 21:e918525e529d 187 connectionLostFP connectionLostHandler;
icraggs 20:cad3d54d7ecf 188
icraggs 20:cad3d54d7ecf 189 };
icraggs 20:cad3d54d7ecf 190
icraggs 20:cad3d54d7ecf 191 }
icraggs 20:cad3d54d7ecf 192
icraggs 20:cad3d54d7ecf 193
icraggs 21:e918525e529d 194 template<class Network, class Timer, class Thread, class Mutex> void MQTT::Async<Network, Timer, Thread, Mutex>::threadfn(void* arg)
icraggs 20:cad3d54d7ecf 195 {
icraggs 21:e918525e529d 196 ((Async<Network, Timer, Thread, Mutex>*) arg)->run(NULL);
icraggs 20:cad3d54d7ecf 197 }
icraggs 20:cad3d54d7ecf 198
icraggs 20:cad3d54d7ecf 199
icraggs 21:e918525e529d 200 template<class Network, class Timer, class Thread, class Mutex> MQTT::Async<Network, Timer, Thread, Mutex>::Async(Network* network, Limits limits) : limits(limits), packetid()
icraggs 20:cad3d54d7ecf 201 {
icraggs 20:cad3d54d7ecf 202 this->thread = 0;
icraggs 20:cad3d54d7ecf 203 this->ipstack = network;
icraggs 20:cad3d54d7ecf 204 this->ping_timer = Timer();
icraggs 20:cad3d54d7ecf 205 this->ping_outstanding = 0;
icraggs 20:cad3d54d7ecf 206
icraggs 20:cad3d54d7ecf 207 // How to make these memory allocations portable? I was hoping to avoid the heap
ericliang 45:bd3567993b26 208 printf("size=%d\n",limits.MAX_MQTT_PACKET_SIZE);
icraggs 20:cad3d54d7ecf 209 buf = new char[limits.MAX_MQTT_PACKET_SIZE];
icraggs 20:cad3d54d7ecf 210 readbuf = new char[limits.MAX_MQTT_PACKET_SIZE];
icraggs 20:cad3d54d7ecf 211 this->operations = new struct Operations[limits.MAX_CONCURRENT_OPERATIONS];
icraggs 20:cad3d54d7ecf 212 for (int i = 0; i < limits.MAX_CONCURRENT_OPERATIONS; ++i)
icraggs 20:cad3d54d7ecf 213 operations[i].id = 0;
icraggs 20:cad3d54d7ecf 214 this->messageHandlers = new struct MessageHandlers[limits.MAX_MESSAGE_HANDLERS];
icraggs 20:cad3d54d7ecf 215 for (int i = 0; i < limits.MAX_MESSAGE_HANDLERS; ++i)
icraggs 20:cad3d54d7ecf 216 messageHandlers[i].topic = 0;
icraggs 20:cad3d54d7ecf 217 }
icraggs 20:cad3d54d7ecf 218
icraggs 20:cad3d54d7ecf 219
icraggs 21:e918525e529d 220 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::sendPacket(int length, int timeout)
icraggs 20:cad3d54d7ecf 221 {
icraggs 20:cad3d54d7ecf 222 int sent = 0;
icraggs 20:cad3d54d7ecf 223
icraggs 20:cad3d54d7ecf 224 while (sent < length)
icraggs 20:cad3d54d7ecf 225 sent += ipstack->write(&buf[sent], length, timeout);
icraggs 20:cad3d54d7ecf 226 if (sent == length)
icraggs 20:cad3d54d7ecf 227 ping_timer.countdown(this->keepAliveInterval); // record the fact that we have successfully sent the packet
icraggs 20:cad3d54d7ecf 228 return sent;
icraggs 20:cad3d54d7ecf 229 }
icraggs 20:cad3d54d7ecf 230
icraggs 20:cad3d54d7ecf 231
icraggs 21:e918525e529d 232 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::decodePacket(int* value, int timeout)
icraggs 20:cad3d54d7ecf 233 {
icraggs 20:cad3d54d7ecf 234 char c;
icraggs 20:cad3d54d7ecf 235 int multiplier = 1;
icraggs 20:cad3d54d7ecf 236 int len = 0;
icraggs 20:cad3d54d7ecf 237 const int MAX_NO_OF_REMAINING_LENGTH_BYTES = 4;
icraggs 20:cad3d54d7ecf 238
icraggs 20:cad3d54d7ecf 239 *value = 0;
icraggs 20:cad3d54d7ecf 240 do
icraggs 20:cad3d54d7ecf 241 {
icraggs 20:cad3d54d7ecf 242 int rc = MQTTPACKET_READ_ERROR;
icraggs 20:cad3d54d7ecf 243
icraggs 20:cad3d54d7ecf 244 if (++len > MAX_NO_OF_REMAINING_LENGTH_BYTES)
icraggs 20:cad3d54d7ecf 245 {
icraggs 20:cad3d54d7ecf 246 rc = MQTTPACKET_READ_ERROR; /* bad data */
icraggs 20:cad3d54d7ecf 247 goto exit;
icraggs 20:cad3d54d7ecf 248 }
icraggs 20:cad3d54d7ecf 249 rc = ipstack->read(&c, 1, timeout);
icraggs 20:cad3d54d7ecf 250 if (rc != 1)
icraggs 20:cad3d54d7ecf 251 goto exit;
icraggs 20:cad3d54d7ecf 252 *value += (c & 127) * multiplier;
icraggs 20:cad3d54d7ecf 253 multiplier *= 128;
icraggs 20:cad3d54d7ecf 254 } while ((c & 128) != 0);
icraggs 20:cad3d54d7ecf 255 exit:
icraggs 20:cad3d54d7ecf 256 return len;
icraggs 20:cad3d54d7ecf 257 }
icraggs 20:cad3d54d7ecf 258
icraggs 20:cad3d54d7ecf 259
icraggs 20:cad3d54d7ecf 260 /**
icraggs 20:cad3d54d7ecf 261 * If any read fails in this method, then we should disconnect from the network, as on reconnect
icraggs 20:cad3d54d7ecf 262 * the packets can be retried.
icraggs 20:cad3d54d7ecf 263 * @param timeout the max time to wait for the packet read to complete, in milliseconds
icraggs 20:cad3d54d7ecf 264 * @return the MQTT packet type, or -1 if none
icraggs 20:cad3d54d7ecf 265 */
icraggs 21:e918525e529d 266 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::readPacket(int timeout)
icraggs 20:cad3d54d7ecf 267 {
icraggs 20:cad3d54d7ecf 268 int rc = -1;
icraggs 20:cad3d54d7ecf 269 MQTTHeader header = {0};
icraggs 20:cad3d54d7ecf 270 int len = 0;
icraggs 20:cad3d54d7ecf 271 int rem_len = 0;
icraggs 20:cad3d54d7ecf 272
icraggs 20:cad3d54d7ecf 273 /* 1. read the header byte. This has the packet type in it */
icraggs 20:cad3d54d7ecf 274 if (ipstack->read(readbuf, 1, timeout) != 1)
icraggs 20:cad3d54d7ecf 275 goto exit;
icraggs 20:cad3d54d7ecf 276
icraggs 20:cad3d54d7ecf 277 len = 1;
icraggs 20:cad3d54d7ecf 278 /* 2. read the remaining length. This is variable in itself */
icraggs 20:cad3d54d7ecf 279 decodePacket(&rem_len, timeout);
icraggs 20:cad3d54d7ecf 280 len += MQTTPacket_encode(readbuf + 1, rem_len); /* put the original remaining length back into the buffer */
icraggs 20:cad3d54d7ecf 281
icraggs 20:cad3d54d7ecf 282 /* 3. read the rest of the buffer using a callback to supply the rest of the data */
icraggs 20:cad3d54d7ecf 283 if (ipstack->read(readbuf + len, rem_len, timeout) != rem_len)
icraggs 20:cad3d54d7ecf 284 goto exit;
icraggs 20:cad3d54d7ecf 285
icraggs 20:cad3d54d7ecf 286 header.byte = readbuf[0];
icraggs 20:cad3d54d7ecf 287 rc = header.bits.type;
icraggs 20:cad3d54d7ecf 288 exit:
icraggs 20:cad3d54d7ecf 289 return rc;
icraggs 20:cad3d54d7ecf 290 }
icraggs 20:cad3d54d7ecf 291
icraggs 20:cad3d54d7ecf 292
icraggs 21:e918525e529d 293 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::deliverMessage(MQTTString* topic, Message* message)
icraggs 20:cad3d54d7ecf 294 {
icraggs 20:cad3d54d7ecf 295 int rc = -1;
icraggs 20:cad3d54d7ecf 296
icraggs 20:cad3d54d7ecf 297 // we have to find the right message handler - indexed by topic
icraggs 20:cad3d54d7ecf 298 for (int i = 0; i < limits.MAX_MESSAGE_HANDLERS; ++i)
icraggs 20:cad3d54d7ecf 299 {
icraggs 20:cad3d54d7ecf 300 if (messageHandlers[i].topic != 0 && MQTTPacket_equals(topic, (char*)messageHandlers[i].topic))
icraggs 20:cad3d54d7ecf 301 {
icraggs 20:cad3d54d7ecf 302 messageHandlers[i].fp(message);
icraggs 20:cad3d54d7ecf 303 rc = 0;
icraggs 20:cad3d54d7ecf 304 break;
icraggs 20:cad3d54d7ecf 305 }
icraggs 20:cad3d54d7ecf 306 }
icraggs 20:cad3d54d7ecf 307
icraggs 20:cad3d54d7ecf 308 return rc;
icraggs 20:cad3d54d7ecf 309 }
icraggs 20:cad3d54d7ecf 310
icraggs 20:cad3d54d7ecf 311
icraggs 20:cad3d54d7ecf 312
icraggs 21:e918525e529d 313 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::cycle(int timeout)
icraggs 20:cad3d54d7ecf 314 {
icraggs 20:cad3d54d7ecf 315 /* get one piece of work off the wire and one pass through */
icraggs 20:cad3d54d7ecf 316
icraggs 20:cad3d54d7ecf 317 // read the socket, see what work is due
icraggs 20:cad3d54d7ecf 318 int packet_type = readPacket(timeout);
icraggs 20:cad3d54d7ecf 319
icraggs 20:cad3d54d7ecf 320 int len, rc;
icraggs 20:cad3d54d7ecf 321 switch (packet_type)
icraggs 20:cad3d54d7ecf 322 {
icraggs 20:cad3d54d7ecf 323 case CONNACK:
icraggs 20:cad3d54d7ecf 324 if (this->thread)
icraggs 20:cad3d54d7ecf 325 {
icraggs 20:cad3d54d7ecf 326 Result res = {this, 0};
icraggs 21:e918525e529d 327 if (MQTTDeserialize_connack(&res.rc, readbuf, limits.MAX_MQTT_PACKET_SIZE) == 1)
icraggs 20:cad3d54d7ecf 328 ;
icraggs 20:cad3d54d7ecf 329 connectHandler(&res);
icraggs 20:cad3d54d7ecf 330 connectHandler.detach(); // only invoke the callback once
icraggs 20:cad3d54d7ecf 331 }
icraggs 20:cad3d54d7ecf 332 break;
icraggs 20:cad3d54d7ecf 333 case PUBACK:
icraggs 20:cad3d54d7ecf 334 if (this->thread)
icraggs 20:cad3d54d7ecf 335 ; //call resultHandler
icraggs 20:cad3d54d7ecf 336 case SUBACK:
icraggs 20:cad3d54d7ecf 337 break;
icraggs 20:cad3d54d7ecf 338 case PUBLISH:
icraggs 20:cad3d54d7ecf 339 MQTTString topicName;
icraggs 20:cad3d54d7ecf 340 Message msg;
icraggs 20:cad3d54d7ecf 341 rc = MQTTDeserialize_publish((int*)&msg.dup, (int*)&msg.qos, (int*)&msg.retained, (int*)&msg.id, &topicName,
icraggs 20:cad3d54d7ecf 342 (char**)&msg.payload, (int*)&msg.payloadlen, readbuf, limits.MAX_MQTT_PACKET_SIZE);;
icraggs 20:cad3d54d7ecf 343 if (msg.qos == QOS0)
icraggs 20:cad3d54d7ecf 344 deliverMessage(&topicName, &msg);
icraggs 20:cad3d54d7ecf 345 break;
icraggs 20:cad3d54d7ecf 346 case PUBREC:
icraggs 20:cad3d54d7ecf 347 int type, dup, mypacketid;
icraggs 20:cad3d54d7ecf 348 if (MQTTDeserialize_ack(&type, &dup, &mypacketid, readbuf, limits.MAX_MQTT_PACKET_SIZE) == 1)
icraggs 20:cad3d54d7ecf 349 ;
icraggs 20:cad3d54d7ecf 350 // must lock this access against the application thread, if we are multi-threaded
icraggs 20:cad3d54d7ecf 351 len = MQTTSerialize_ack(buf, limits.MAX_MQTT_PACKET_SIZE, PUBREL, 0, mypacketid);
icraggs 20:cad3d54d7ecf 352 rc = sendPacket(len, timeout); // send the PUBREL packet
icraggs 20:cad3d54d7ecf 353 if (rc != len)
icraggs 20:cad3d54d7ecf 354 goto exit; // there was a problem
icraggs 20:cad3d54d7ecf 355
icraggs 20:cad3d54d7ecf 356 break;
icraggs 20:cad3d54d7ecf 357 case PUBCOMP:
icraggs 20:cad3d54d7ecf 358 break;
icraggs 20:cad3d54d7ecf 359 case PINGRESP:
icraggs 20:cad3d54d7ecf 360 ping_outstanding = false;
icraggs 20:cad3d54d7ecf 361 break;
icraggs 20:cad3d54d7ecf 362 }
icraggs 20:cad3d54d7ecf 363 keepalive();
icraggs 20:cad3d54d7ecf 364 exit:
icraggs 20:cad3d54d7ecf 365 return packet_type;
icraggs 20:cad3d54d7ecf 366 }
icraggs 20:cad3d54d7ecf 367
icraggs 20:cad3d54d7ecf 368
icraggs 21:e918525e529d 369 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::keepalive()
icraggs 20:cad3d54d7ecf 370 {
icraggs 20:cad3d54d7ecf 371 int rc = 0;
icraggs 20:cad3d54d7ecf 372
icraggs 20:cad3d54d7ecf 373 if (keepAliveInterval == 0)
icraggs 20:cad3d54d7ecf 374 goto exit;
icraggs 20:cad3d54d7ecf 375
icraggs 20:cad3d54d7ecf 376 if (ping_timer.expired())
icraggs 20:cad3d54d7ecf 377 {
icraggs 20:cad3d54d7ecf 378 if (ping_outstanding)
icraggs 20:cad3d54d7ecf 379 rc = -1;
icraggs 20:cad3d54d7ecf 380 else
icraggs 20:cad3d54d7ecf 381 {
icraggs 20:cad3d54d7ecf 382 int len = MQTTSerialize_pingreq(buf, limits.MAX_MQTT_PACKET_SIZE);
icraggs 20:cad3d54d7ecf 383 rc = sendPacket(len, 1000); // send the ping packet
icraggs 20:cad3d54d7ecf 384 if (rc != len)
icraggs 20:cad3d54d7ecf 385 rc = -1; // indicate there's a problem
icraggs 20:cad3d54d7ecf 386 else
icraggs 20:cad3d54d7ecf 387 ping_outstanding = true;
icraggs 20:cad3d54d7ecf 388 }
icraggs 20:cad3d54d7ecf 389 }
icraggs 20:cad3d54d7ecf 390
icraggs 20:cad3d54d7ecf 391 exit:
icraggs 20:cad3d54d7ecf 392 return rc;
icraggs 20:cad3d54d7ecf 393 }
icraggs 20:cad3d54d7ecf 394
icraggs 20:cad3d54d7ecf 395
icraggs 21:e918525e529d 396 template<class Network, class Timer, class Thread, class Mutex> void MQTT::Async<Network, Timer, Thread, Mutex>::run(void const *argument)
icraggs 20:cad3d54d7ecf 397 {
icraggs 20:cad3d54d7ecf 398 while (true)
icraggs 20:cad3d54d7ecf 399 cycle(ping_timer.left_ms());
icraggs 20:cad3d54d7ecf 400 }
icraggs 20:cad3d54d7ecf 401
icraggs 20:cad3d54d7ecf 402
icraggs 20:cad3d54d7ecf 403 // only used in single-threaded mode where one command at a time is in process
icraggs 21:e918525e529d 404 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::waitfor(int packet_type, Timer& atimer)
icraggs 20:cad3d54d7ecf 405 {
icraggs 20:cad3d54d7ecf 406 int rc = -1;
icraggs 20:cad3d54d7ecf 407
icraggs 20:cad3d54d7ecf 408 do
icraggs 20:cad3d54d7ecf 409 {
icraggs 20:cad3d54d7ecf 410 if (atimer.expired())
icraggs 20:cad3d54d7ecf 411 break; // we timed out
icraggs 20:cad3d54d7ecf 412 }
icraggs 20:cad3d54d7ecf 413 while ((rc = cycle(atimer.left_ms())) != packet_type);
icraggs 20:cad3d54d7ecf 414
icraggs 20:cad3d54d7ecf 415 return rc;
icraggs 20:cad3d54d7ecf 416 }
icraggs 20:cad3d54d7ecf 417
icraggs 20:cad3d54d7ecf 418
icraggs 21:e918525e529d 419 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::connect(resultHandler resultHandler, MQTTPacket_connectData* options)
icraggs 20:cad3d54d7ecf 420 {
icraggs 21:e918525e529d 421 connect_timer.countdown(limits.command_timeout_ms);
icraggs 20:cad3d54d7ecf 422
icraggs 20:cad3d54d7ecf 423 MQTTPacket_connectData default_options = MQTTPacket_connectData_initializer;
icraggs 20:cad3d54d7ecf 424 if (options == 0)
icraggs 20:cad3d54d7ecf 425 options = &default_options; // set default options if none were supplied
icraggs 20:cad3d54d7ecf 426
icraggs 20:cad3d54d7ecf 427 this->keepAliveInterval = options->keepAliveInterval;
icraggs 20:cad3d54d7ecf 428 ping_timer.countdown(this->keepAliveInterval);
icraggs 20:cad3d54d7ecf 429 int len = MQTTSerialize_connect(buf, limits.MAX_MQTT_PACKET_SIZE, options);
icraggs 20:cad3d54d7ecf 430 int rc = sendPacket(len, connect_timer.left_ms()); // send the connect packet
icraggs 20:cad3d54d7ecf 431 if (rc != len)
icraggs 20:cad3d54d7ecf 432 goto exit; // there was a problem
icraggs 20:cad3d54d7ecf 433
icraggs 20:cad3d54d7ecf 434 if (resultHandler == 0) // wait until the connack is received
icraggs 20:cad3d54d7ecf 435 {
icraggs 20:cad3d54d7ecf 436 // this will be a blocking call, wait for the connack
icraggs 20:cad3d54d7ecf 437 if (waitfor(CONNACK, connect_timer) == CONNACK)
icraggs 20:cad3d54d7ecf 438 {
icraggs 20:cad3d54d7ecf 439 int connack_rc = -1;
icraggs 20:cad3d54d7ecf 440 if (MQTTDeserialize_connack(&connack_rc, readbuf, limits.MAX_MQTT_PACKET_SIZE) == 1)
icraggs 20:cad3d54d7ecf 441 rc = connack_rc;
icraggs 20:cad3d54d7ecf 442 }
icraggs 20:cad3d54d7ecf 443 }
icraggs 20:cad3d54d7ecf 444 else
icraggs 20:cad3d54d7ecf 445 {
icraggs 20:cad3d54d7ecf 446 // set connect response callback function
icraggs 20:cad3d54d7ecf 447 connectHandler.attach(resultHandler);
icraggs 20:cad3d54d7ecf 448
icraggs 20:cad3d54d7ecf 449 // start background thread
icraggs 21:e918525e529d 450 this->thread = new Thread((void (*)(void const *argument))&MQTT::Async<Network, Timer, Thread, Mutex>::threadfn, (void*)this);
icraggs 20:cad3d54d7ecf 451 }
icraggs 20:cad3d54d7ecf 452
icraggs 20:cad3d54d7ecf 453 exit:
icraggs 20:cad3d54d7ecf 454 return rc;
icraggs 20:cad3d54d7ecf 455 }
icraggs 20:cad3d54d7ecf 456
icraggs 20:cad3d54d7ecf 457
icraggs 21:e918525e529d 458 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::findFreeOperation()
icraggs 20:cad3d54d7ecf 459 {
icraggs 20:cad3d54d7ecf 460 int found = -1;
icraggs 20:cad3d54d7ecf 461 for (int i = 0; i < limits.MAX_CONCURRENT_OPERATIONS; ++i)
icraggs 20:cad3d54d7ecf 462 {
icraggs 20:cad3d54d7ecf 463 if (operations[i].id == 0)
icraggs 20:cad3d54d7ecf 464 {
icraggs 20:cad3d54d7ecf 465 found = i;
icraggs 20:cad3d54d7ecf 466 break;
icraggs 20:cad3d54d7ecf 467 }
icraggs 20:cad3d54d7ecf 468 }
icraggs 20:cad3d54d7ecf 469 return found;
icraggs 20:cad3d54d7ecf 470 }
icraggs 20:cad3d54d7ecf 471
icraggs 20:cad3d54d7ecf 472
icraggs 21:e918525e529d 473 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::subscribe(resultHandler resultHandler, const char* topicFilter, enum QoS qos, messageHandler messageHandler)
icraggs 20:cad3d54d7ecf 474 {
icraggs 20:cad3d54d7ecf 475 int index = 0;
icraggs 20:cad3d54d7ecf 476 if (this->thread)
icraggs 20:cad3d54d7ecf 477 index = findFreeOperation();
icraggs 20:cad3d54d7ecf 478 Timer& atimer = operations[index].timer;
icraggs 20:cad3d54d7ecf 479
icraggs 21:e918525e529d 480 atimer.countdown(limits.command_timeout_ms);
icraggs 20:cad3d54d7ecf 481 MQTTString topic = {(char*)topicFilter, 0, 0};
icraggs 20:cad3d54d7ecf 482
icraggs 20:cad3d54d7ecf 483 int len = MQTTSerialize_subscribe(buf, limits.MAX_MQTT_PACKET_SIZE, 0, packetid.getNext(), 1, &topic, (int*)&qos);
icraggs 20:cad3d54d7ecf 484 int rc = sendPacket(len, atimer.left_ms()); // send the subscribe packet
icraggs 20:cad3d54d7ecf 485 if (rc != len)
icraggs 20:cad3d54d7ecf 486 goto exit; // there was a problem
icraggs 20:cad3d54d7ecf 487
icraggs 20:cad3d54d7ecf 488 /* wait for suback */
icraggs 20:cad3d54d7ecf 489 if (resultHandler == 0)
icraggs 20:cad3d54d7ecf 490 {
icraggs 20:cad3d54d7ecf 491 // this will block
icraggs 20:cad3d54d7ecf 492 if (waitfor(SUBACK, atimer) == SUBACK)
icraggs 20:cad3d54d7ecf 493 {
icraggs 20:cad3d54d7ecf 494 int count = 0, grantedQoS = -1, mypacketid;
icraggs 20:cad3d54d7ecf 495 if (MQTTDeserialize_suback(&mypacketid, 1, &count, &grantedQoS, readbuf, limits.MAX_MQTT_PACKET_SIZE) == 1)
icraggs 20:cad3d54d7ecf 496 rc = grantedQoS; // 0, 1, 2 or 0x80
icraggs 20:cad3d54d7ecf 497 if (rc != 0x80)
icraggs 20:cad3d54d7ecf 498 {
icraggs 20:cad3d54d7ecf 499 for (int i = 0; i < limits.MAX_MESSAGE_HANDLERS; ++i)
icraggs 20:cad3d54d7ecf 500 {
icraggs 20:cad3d54d7ecf 501 if (messageHandlers[i].topic == 0)
icraggs 20:cad3d54d7ecf 502 {
icraggs 20:cad3d54d7ecf 503 messageHandlers[i].topic = topicFilter;
icraggs 20:cad3d54d7ecf 504 messageHandlers[i].fp.attach(messageHandler);
icraggs 20:cad3d54d7ecf 505 rc = 0;
icraggs 20:cad3d54d7ecf 506 break;
icraggs 20:cad3d54d7ecf 507 }
icraggs 20:cad3d54d7ecf 508 }
icraggs 20:cad3d54d7ecf 509 }
icraggs 20:cad3d54d7ecf 510 }
icraggs 20:cad3d54d7ecf 511 }
icraggs 20:cad3d54d7ecf 512 else
icraggs 20:cad3d54d7ecf 513 {
icraggs 20:cad3d54d7ecf 514 // set subscribe response callback function
icraggs 20:cad3d54d7ecf 515
icraggs 20:cad3d54d7ecf 516 }
icraggs 20:cad3d54d7ecf 517
icraggs 20:cad3d54d7ecf 518 exit:
icraggs 20:cad3d54d7ecf 519 return rc;
icraggs 20:cad3d54d7ecf 520 }
icraggs 20:cad3d54d7ecf 521
icraggs 20:cad3d54d7ecf 522
icraggs 21:e918525e529d 523 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::unsubscribe(resultHandler resultHandler, const char* topicFilter)
icraggs 20:cad3d54d7ecf 524 {
icraggs 20:cad3d54d7ecf 525 int index = 0;
icraggs 20:cad3d54d7ecf 526 if (this->thread)
icraggs 20:cad3d54d7ecf 527 index = findFreeOperation();
icraggs 20:cad3d54d7ecf 528 Timer& atimer = operations[index].timer;
icraggs 20:cad3d54d7ecf 529
icraggs 21:e918525e529d 530 atimer.countdown(limits.command_timeout_ms);
icraggs 20:cad3d54d7ecf 531 MQTTString topic = {(char*)topicFilter, 0, 0};
icraggs 20:cad3d54d7ecf 532
icraggs 20:cad3d54d7ecf 533 int len = MQTTSerialize_unsubscribe(buf, limits.MAX_MQTT_PACKET_SIZE, 0, packetid.getNext(), 1, &topic);
icraggs 20:cad3d54d7ecf 534 int rc = sendPacket(len, atimer.left_ms()); // send the subscribe packet
icraggs 20:cad3d54d7ecf 535 if (rc != len)
icraggs 20:cad3d54d7ecf 536 goto exit; // there was a problem
icraggs 20:cad3d54d7ecf 537
icraggs 21:e918525e529d 538 // set unsubscribe response callback function
icraggs 20:cad3d54d7ecf 539
icraggs 20:cad3d54d7ecf 540
icraggs 20:cad3d54d7ecf 541 exit:
icraggs 20:cad3d54d7ecf 542 return rc;
icraggs 20:cad3d54d7ecf 543 }
icraggs 20:cad3d54d7ecf 544
icraggs 20:cad3d54d7ecf 545
icraggs 20:cad3d54d7ecf 546
icraggs 21:e918525e529d 547 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::publish(resultHandler resultHandler, const char* topicName, Message* message)
icraggs 20:cad3d54d7ecf 548 {
icraggs 20:cad3d54d7ecf 549 int index = 0;
icraggs 20:cad3d54d7ecf 550 if (this->thread)
icraggs 20:cad3d54d7ecf 551 index = findFreeOperation();
icraggs 20:cad3d54d7ecf 552 Timer& atimer = operations[index].timer;
icraggs 20:cad3d54d7ecf 553
icraggs 21:e918525e529d 554 atimer.countdown(limits.command_timeout_ms);
icraggs 20:cad3d54d7ecf 555 MQTTString topic = {(char*)topicName, 0, 0};
icraggs 20:cad3d54d7ecf 556
icraggs 20:cad3d54d7ecf 557 if (message->qos == QOS1 || message->qos == QOS2)
icraggs 20:cad3d54d7ecf 558 message->id = packetid.getNext();
ericliang 45:bd3567993b26 559
icraggs 20:cad3d54d7ecf 560 int len = MQTTSerialize_publish(buf, limits.MAX_MQTT_PACKET_SIZE, 0, message->qos, message->retained, message->id, topic, (char*)message->payload, message->payloadlen);
icraggs 20:cad3d54d7ecf 561 int rc = sendPacket(len, atimer.left_ms()); // send the subscribe packet
icraggs 20:cad3d54d7ecf 562 if (rc != len)
icraggs 20:cad3d54d7ecf 563 goto exit; // there was a problem
icraggs 20:cad3d54d7ecf 564
icraggs 20:cad3d54d7ecf 565 /* wait for acks */
icraggs 20:cad3d54d7ecf 566 if (resultHandler == 0)
icraggs 20:cad3d54d7ecf 567 {
icraggs 20:cad3d54d7ecf 568 if (message->qos == QOS1)
icraggs 20:cad3d54d7ecf 569 {
icraggs 20:cad3d54d7ecf 570 if (waitfor(PUBACK, atimer) == PUBACK)
icraggs 20:cad3d54d7ecf 571 {
icraggs 20:cad3d54d7ecf 572 int type, dup, mypacketid;
icraggs 20:cad3d54d7ecf 573 if (MQTTDeserialize_ack(&type, &dup, &mypacketid, readbuf, limits.MAX_MQTT_PACKET_SIZE) == 1)
icraggs 20:cad3d54d7ecf 574 rc = 0;
icraggs 20:cad3d54d7ecf 575 }
icraggs 20:cad3d54d7ecf 576 }
icraggs 20:cad3d54d7ecf 577 else if (message->qos == QOS2)
icraggs 20:cad3d54d7ecf 578 {
icraggs 20:cad3d54d7ecf 579 if (waitfor(PUBCOMP, atimer) == PUBCOMP)
icraggs 20:cad3d54d7ecf 580 {
icraggs 20:cad3d54d7ecf 581 int type, dup, mypacketid;
icraggs 20:cad3d54d7ecf 582 if (MQTTDeserialize_ack(&type, &dup, &mypacketid, readbuf, limits.MAX_MQTT_PACKET_SIZE) == 1)
icraggs 20:cad3d54d7ecf 583 rc = 0;
icraggs 20:cad3d54d7ecf 584 }
icraggs 20:cad3d54d7ecf 585
icraggs 20:cad3d54d7ecf 586 }
icraggs 20:cad3d54d7ecf 587 }
icraggs 20:cad3d54d7ecf 588 else
icraggs 20:cad3d54d7ecf 589 {
icraggs 20:cad3d54d7ecf 590 // set publish response callback function
icraggs 20:cad3d54d7ecf 591
icraggs 20:cad3d54d7ecf 592 }
icraggs 20:cad3d54d7ecf 593
icraggs 20:cad3d54d7ecf 594 exit:
icraggs 20:cad3d54d7ecf 595 return rc;
icraggs 20:cad3d54d7ecf 596 }
icraggs 20:cad3d54d7ecf 597
icraggs 20:cad3d54d7ecf 598
icraggs 21:e918525e529d 599 template<class Network, class Timer, class Thread, class Mutex> int MQTT::Async<Network, Timer, Thread, Mutex>::disconnect(resultHandler resultHandler)
icraggs 21:e918525e529d 600 {
icraggs 21:e918525e529d 601 Timer timer = Timer(limits.command_timeout_ms); // we might wait for incomplete incoming publishes to complete
icraggs 21:e918525e529d 602 int len = MQTTSerialize_disconnect(buf, limits.MAX_MQTT_PACKET_SIZE);
icraggs 21:e918525e529d 603 int rc = sendPacket(len, timer.left_ms()); // send the disconnect packet
icraggs 21:e918525e529d 604
icraggs 21:e918525e529d 605 return (rc == len) ? 0 : -1;
icraggs 21:e918525e529d 606 }
icraggs 21:e918525e529d 607
icraggs 21:e918525e529d 608
icraggs 21:e918525e529d 609
icraggs 23:05fc7de97d4a 610 #endif