Duy tran / MQTT-v-16

v-16

Dependencies:   FP MQTTPacket

MQTTAsync.h@0:818366b014c9, 2017-12-12 (annotated)

Committer:
DuyLionTran
Date:
Tue Dec 12 15:58:09 2017 +0000
Revision:
0:818366b014c9
version 1.6;

Who changed what in which revision?

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