Junichi Katsu / Milkcocoa-os

【mbed OS5対応バージョン】データの保存、更新、取得ができるWebサービス「milkcocoa」に接続し、データのプッシュ、送信、取得ができるライブラリです。 https://mlkcca.com/

Dependents:   mbed-os-example-wifi-milkcocoa MilkcocoaOsSample_Eth MilkcocoaOsSample_ESP8266 MilkcocoaOsSample_Eth_DigitalIn

MQTT/MQTTClient.h@8:e2f15b1b4f70, 2017-06-14 (annotated)

Committer:
jksoft
Date:
Wed Jun 14 07:48:45 2017 +0000
Revision:
8:e2f15b1b4f70
Parent:
1:8e4149b53a8a 
?????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jksoft 0:0a2f634d3324 1 /*******************************************************************************
jksoft 0:0a2f634d3324 2 * Copyright (c) 2014, 2015 IBM Corp.
jksoft 0:0a2f634d3324 3 *
jksoft 0:0a2f634d3324 4 * All rights reserved. This program and the accompanying materials
jksoft 0:0a2f634d3324 5 * are made available under the terms of the Eclipse Public License v1.0
jksoft 0:0a2f634d3324 6 * and Eclipse Distribution License v1.0 which accompany this distribution.
jksoft 0:0a2f634d3324 7 *
jksoft 0:0a2f634d3324 8 * The Eclipse Public License is available at
jksoft 0:0a2f634d3324 9 * http://www.eclipse.org/legal/epl-v10.html
jksoft 0:0a2f634d3324 10 * and the Eclipse Distribution License is available at
jksoft 0:0a2f634d3324 11 * http://www.eclipse.org/org/documents/edl-v10.php.
jksoft 0:0a2f634d3324 12 *
jksoft 0:0a2f634d3324 13 * Contributors:
jksoft 0:0a2f634d3324 14 * Ian Craggs - initial API and implementation and/or initial documentation
jksoft 0:0a2f634d3324 15 * Ian Craggs - fix for bug 458512 - QoS 2 messages
jksoft 0:0a2f634d3324 16 * Ian Craggs - fix for bug 460389 - send loop uses wrong length
jksoft 0:0a2f634d3324 17 * Ian Craggs - fix for bug 464169 - clearing subscriptions
jksoft 0:0a2f634d3324 18 * Ian Craggs - fix for bug 464551 - enums and ints can be different size
jksoft 0:0a2f634d3324 19 *******************************************************************************/
jksoft 0:0a2f634d3324 20
jksoft 0:0a2f634d3324 21 #if !defined(MQTTCLIENT_H)
jksoft 0:0a2f634d3324 22 #define MQTTCLIENT_H
jksoft 0:0a2f634d3324 23
jksoft 0:0a2f634d3324 24 #include "FP.h"
jksoft 0:0a2f634d3324 25 #include "MQTTPacket.h"
jksoft 0:0a2f634d3324 26 #include "stdio.h"
jksoft 0:0a2f634d3324 27 #include "MQTTLogging.h"
jksoft 0:0a2f634d3324 28
jksoft 0:0a2f634d3324 29 #if !defined(MQTTCLIENT_QOS1)
jksoft 0:0a2f634d3324 30 #define MQTTCLIENT_QOS1 1
jksoft 0:0a2f634d3324 31 #endif
jksoft 0:0a2f634d3324 32 #if !defined(MQTTCLIENT_QOS2)
jksoft 0:0a2f634d3324 33 #define MQTTCLIENT_QOS2 0
jksoft 0:0a2f634d3324 34 #endif
jksoft 0:0a2f634d3324 35
jksoft 0:0a2f634d3324 36 #if 1
jksoft 0:0a2f634d3324 37 extern RawSerial pc;
jksoft 0:0a2f634d3324 38
jksoft 0:0a2f634d3324 39 #define DBG(x) x
jksoft 0:0a2f634d3324 40 #else
jksoft 0:0a2f634d3324 41 #define DBG(x)
jksoft 0:0a2f634d3324 42 #endif
jksoft 0:0a2f634d3324 43
jksoft 0:0a2f634d3324 44 namespace MQTT
jksoft 0:0a2f634d3324 45 {
jksoft 0:0a2f634d3324 46
jksoft 0:0a2f634d3324 47
jksoft 0:0a2f634d3324 48 enum QoS { QOS0, QOS1, QOS2 };
jksoft 0:0a2f634d3324 49
jksoft 0:0a2f634d3324 50 // all failure return codes must be negative
jksoft 0:0a2f634d3324 51 enum returnCode { BUFFER_OVERFLOW = -2, FAILURE = -1, SUCCESS = 0 };
jksoft 0:0a2f634d3324 52
jksoft 0:0a2f634d3324 53
jksoft 0:0a2f634d3324 54 struct Message
jksoft 0:0a2f634d3324 55 {
jksoft 0:0a2f634d3324 56 enum QoS qos;
jksoft 0:0a2f634d3324 57 bool retained;
jksoft 0:0a2f634d3324 58 bool dup;
jksoft 0:0a2f634d3324 59 unsigned short id;
jksoft 0:0a2f634d3324 60 void *payload;
jksoft 0:0a2f634d3324 61 size_t payloadlen;
jksoft 0:0a2f634d3324 62 };
jksoft 0:0a2f634d3324 63
jksoft 0:0a2f634d3324 64
jksoft 0:0a2f634d3324 65 struct MessageData
jksoft 0:0a2f634d3324 66 {
jksoft 0:0a2f634d3324 67 MessageData(MQTTString &aTopicName, struct Message &aMessage) : message(aMessage), topicName(aTopicName)
jksoft 0:0a2f634d3324 68 { }
jksoft 0:0a2f634d3324 69
jksoft 0:0a2f634d3324 70 struct Message &message;
jksoft 0:0a2f634d3324 71 MQTTString &topicName;
jksoft 0:0a2f634d3324 72 };
jksoft 0:0a2f634d3324 73
jksoft 0:0a2f634d3324 74
jksoft 0:0a2f634d3324 75 class PacketId
jksoft 0:0a2f634d3324 76 {
jksoft 0:0a2f634d3324 77 public:
jksoft 0:0a2f634d3324 78 PacketId()
jksoft 0:0a2f634d3324 79 {
jksoft 0:0a2f634d3324 80 next = 0;
jksoft 0:0a2f634d3324 81 }
jksoft 0:0a2f634d3324 82
jksoft 0:0a2f634d3324 83 int getNext()
jksoft 0:0a2f634d3324 84 {
jksoft 0:0a2f634d3324 85 return next = (next == MAX_PACKET_ID) ? 1 : ++next;
jksoft 0:0a2f634d3324 86 }
jksoft 0:0a2f634d3324 87
jksoft 0:0a2f634d3324 88 private:
jksoft 0:0a2f634d3324 89 static const int MAX_PACKET_ID = 65535;
jksoft 0:0a2f634d3324 90 int next;
jksoft 0:0a2f634d3324 91 };
jksoft 0:0a2f634d3324 92
jksoft 0:0a2f634d3324 93
jksoft 0:0a2f634d3324 94 /**
jksoft 0:0a2f634d3324 95 * @class Client
jksoft 0:0a2f634d3324 96 * @brief blocking, non-threaded MQTT client API
jksoft 0:0a2f634d3324 97 *
jksoft 0:0a2f634d3324 98 * This version of the API blocks on all method calls, until they are complete. This means that only one
jksoft 0:0a2f634d3324 99 * MQTT request can be in process at any one time.
jksoft 0:0a2f634d3324 100 * @param Network a network class which supports send, receive
jksoft 0:0a2f634d3324 101 * @param Timer a timer class with the methods:
jksoft 0:0a2f634d3324 102 */
jksoft 1:8e4149b53a8a 103 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE = 256, int MAX_MESSAGE_HANDLERS = 5>
jksoft 0:0a2f634d3324 104 class Client
jksoft 0:0a2f634d3324 105 {
jksoft 0:0a2f634d3324 106
jksoft 0:0a2f634d3324 107 public:
jksoft 0:0a2f634d3324 108
jksoft 0:0a2f634d3324 109 typedef void (*messageHandler)(MessageData&);
jksoft 0:0a2f634d3324 110
jksoft 0:0a2f634d3324 111 /** Construct the client
jksoft 0:0a2f634d3324 112 * @param network - pointer to an instance of the Network class - must be connected to the endpoint
jksoft 0:0a2f634d3324 113 * before calling MQTT connect
jksoft 0:0a2f634d3324 114 * @param limits an instance of the Limit class - to alter limits as required
jksoft 0:0a2f634d3324 115 */
jksoft 0:0a2f634d3324 116 Client(Network& network, unsigned int command_timeout_ms = 30000);
jksoft 0:0a2f634d3324 117
jksoft 0:0a2f634d3324 118 /** Set the default message handling callback - used for any message which does not match a subscription message handler
jksoft 0:0a2f634d3324 119 * @param mh - pointer to the callback function
jksoft 0:0a2f634d3324 120 */
jksoft 0:0a2f634d3324 121 void setDefaultMessageHandler(messageHandler mh)
jksoft 0:0a2f634d3324 122 {
jksoft 0:0a2f634d3324 123 defaultMessageHandler.attach(mh);
jksoft 0:0a2f634d3324 124 }
jksoft 0:0a2f634d3324 125
jksoft 0:0a2f634d3324 126 /** MQTT Connect - send an MQTT connect packet down the network and wait for a Connack
jksoft 0:0a2f634d3324 127 * The nework object must be connected to the network endpoint before calling this
jksoft 0:0a2f634d3324 128 * Default connect options are used
jksoft 0:0a2f634d3324 129 * @return success code -
jksoft 0:0a2f634d3324 130 */
jksoft 0:0a2f634d3324 131 int connect();
jksoft 0:0a2f634d3324 132
jksoft 0:0a2f634d3324 133 /** MQTT Connect - send an MQTT connect packet down the network and wait for a Connack
jksoft 0:0a2f634d3324 134 * The nework object must be connected to the network endpoint before calling this
jksoft 0:0a2f634d3324 135 * @param options - connect options
jksoft 0:0a2f634d3324 136 * @return success code -
jksoft 0:0a2f634d3324 137 */
jksoft 0:0a2f634d3324 138 int connect(MQTTPacket_connectData& options);
jksoft 0:0a2f634d3324 139
jksoft 0:0a2f634d3324 140 /** MQTT Publish - send an MQTT publish packet and wait for all acks to complete for all QoSs
jksoft 0:0a2f634d3324 141 * @param topic - the topic to publish to
jksoft 0:0a2f634d3324 142 * @param message - the message to send
jksoft 0:0a2f634d3324 143 * @return success code -
jksoft 0:0a2f634d3324 144 */
jksoft 0:0a2f634d3324 145 int publish(const char* topicName, Message& message);
jksoft 0:0a2f634d3324 146
jksoft 0:0a2f634d3324 147 /** MQTT Publish - send an MQTT publish packet and wait for all acks to complete for all QoSs
jksoft 0:0a2f634d3324 148 * @param topic - the topic to publish to
jksoft 0:0a2f634d3324 149 * @param payload - the data to send
jksoft 0:0a2f634d3324 150 * @param payloadlen - the length of the data
jksoft 0:0a2f634d3324 151 * @param qos - the QoS to send the publish at
jksoft 0:0a2f634d3324 152 * @param retained - whether the message should be retained
jksoft 0:0a2f634d3324 153 * @return success code -
jksoft 0:0a2f634d3324 154 */
jksoft 0:0a2f634d3324 155 int publish(const char* topicName, void* payload, size_t payloadlen, enum QoS qos = QOS0, bool retained = false);
jksoft 0:0a2f634d3324 156
jksoft 0:0a2f634d3324 157 /** MQTT Publish - send an MQTT publish packet and wait for all acks to complete for all QoSs
jksoft 0:0a2f634d3324 158 * @param topic - the topic to publish to
jksoft 0:0a2f634d3324 159 * @param payload - the data to send
jksoft 0:0a2f634d3324 160 * @param payloadlen - the length of the data
jksoft 0:0a2f634d3324 161 * @param id - the packet id used - returned
jksoft 0:0a2f634d3324 162 * @param qos - the QoS to send the publish at
jksoft 0:0a2f634d3324 163 * @param retained - whether the message should be retained
jksoft 0:0a2f634d3324 164 * @return success code -
jksoft 0:0a2f634d3324 165 */
jksoft 0:0a2f634d3324 166 int publish(const char* topicName, void* payload, size_t payloadlen, unsigned short& id, enum QoS qos = QOS1, bool retained = false);
jksoft 0:0a2f634d3324 167
jksoft 0:0a2f634d3324 168 /** MQTT Subscribe - send an MQTT subscribe packet and wait for the suback
jksoft 0:0a2f634d3324 169 * @param topicFilter - a topic pattern which can include wildcards
jksoft 0:0a2f634d3324 170 * @param qos - the MQTT QoS to subscribe at
jksoft 0:0a2f634d3324 171 * @param mh - the callback function to be invoked when a message is received for this subscription
jksoft 0:0a2f634d3324 172 * @return success code -
jksoft 0:0a2f634d3324 173 */
jksoft 0:0a2f634d3324 174 int subscribe(const char* topicFilter, enum QoS qos, messageHandler mh);
jksoft 0:0a2f634d3324 175
jksoft 0:0a2f634d3324 176 /** MQTT Unsubscribe - send an MQTT unsubscribe packet and wait for the unsuback
jksoft 0:0a2f634d3324 177 * @param topicFilter - a topic pattern which can include wildcards
jksoft 0:0a2f634d3324 178 * @return success code -
jksoft 0:0a2f634d3324 179 */
jksoft 0:0a2f634d3324 180 int unsubscribe(const char* topicFilter);
jksoft 0:0a2f634d3324 181
jksoft 0:0a2f634d3324 182 /** MQTT Disconnect - send an MQTT disconnect packet, and clean up any state
jksoft 0:0a2f634d3324 183 * @return success code -
jksoft 0:0a2f634d3324 184 */
jksoft 0:0a2f634d3324 185 int disconnect();
jksoft 0:0a2f634d3324 186
jksoft 0:0a2f634d3324 187 /** A call to this API must be made within the keepAlive interval to keep the MQTT connection alive
jksoft 0:0a2f634d3324 188 * yield can be called if no other MQTT operation is needed. This will also allow messages to be
jksoft 0:0a2f634d3324 189 * received.
jksoft 0:0a2f634d3324 190 * @param timeout_ms the time to wait, in milliseconds
jksoft 0:0a2f634d3324 191 * @return success code - on failure, this means the client has disconnected
jksoft 0:0a2f634d3324 192 */
jksoft 0:0a2f634d3324 193 int yield(unsigned long timeout_ms = 1000L);
jksoft 0:0a2f634d3324 194
jksoft 0:0a2f634d3324 195 /** Is the client connected?
jksoft 0:0a2f634d3324 196 * @return flag - is the client connected or not?
jksoft 0:0a2f634d3324 197 */
jksoft 0:0a2f634d3324 198 bool isConnected()
jksoft 0:0a2f634d3324 199 {
jksoft 0:0a2f634d3324 200 return isconnected;
jksoft 0:0a2f634d3324 201 }
jksoft 0:0a2f634d3324 202
jksoft 0:0a2f634d3324 203 private:
jksoft 0:0a2f634d3324 204
jksoft 0:0a2f634d3324 205 void cleanSession();
jksoft 0:0a2f634d3324 206 int cycle(Timer& timer);
jksoft 0:0a2f634d3324 207 int waitfor(int packet_type, Timer& timer);
jksoft 0:0a2f634d3324 208 int keepalive();
jksoft 0:0a2f634d3324 209 int publish(int len, Timer& timer, enum QoS qos);
jksoft 0:0a2f634d3324 210
jksoft 0:0a2f634d3324 211 int decodePacket(int* value, int timeout);
jksoft 0:0a2f634d3324 212 int readPacket(Timer& timer);
jksoft 0:0a2f634d3324 213 int sendPacket(int length, Timer& timer);
jksoft 0:0a2f634d3324 214 int deliverMessage(MQTTString& topicName, Message& message);
jksoft 0:0a2f634d3324 215 bool isTopicMatched(char* topicFilter, MQTTString& topicName);
jksoft 0:0a2f634d3324 216
jksoft 0:0a2f634d3324 217 Network& ipstack;
jksoft 0:0a2f634d3324 218 unsigned long command_timeout_ms;
jksoft 0:0a2f634d3324 219
jksoft 0:0a2f634d3324 220 unsigned char sendbuf[MAX_MQTT_PACKET_SIZE];
jksoft 0:0a2f634d3324 221 unsigned char readbuf[MAX_MQTT_PACKET_SIZE];
jksoft 0:0a2f634d3324 222
jksoft 0:0a2f634d3324 223 Timer last_sent, last_received;
jksoft 0:0a2f634d3324 224 unsigned int keepAliveInterval;
jksoft 0:0a2f634d3324 225 bool ping_outstanding;
jksoft 0:0a2f634d3324 226 bool cleansession;
jksoft 0:0a2f634d3324 227
jksoft 0:0a2f634d3324 228 PacketId packetid;
jksoft 0:0a2f634d3324 229
jksoft 0:0a2f634d3324 230 struct MessageHandlers
jksoft 0:0a2f634d3324 231 {
jksoft 0:0a2f634d3324 232 const char* topicFilter;
jksoft 8:e2f15b1b4f70 233 FP_<void, MessageData&> fp;
jksoft 0:0a2f634d3324 234 } messageHandlers[MAX_MESSAGE_HANDLERS]; // Message handlers are indexed by subscription topic
jksoft 0:0a2f634d3324 235
jksoft 8:e2f15b1b4f70 236 FP_<void, MessageData&> defaultMessageHandler;
jksoft 0:0a2f634d3324 237
jksoft 0:0a2f634d3324 238 bool isconnected;
jksoft 0:0a2f634d3324 239
jksoft 0:0a2f634d3324 240 #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 241 unsigned char pubbuf[MAX_MQTT_PACKET_SIZE]; // store the last publish for sending on reconnect
jksoft 0:0a2f634d3324 242 int inflightLen;
jksoft 0:0a2f634d3324 243 unsigned short inflightMsgid;
jksoft 0:0a2f634d3324 244 enum QoS inflightQoS;
jksoft 0:0a2f634d3324 245 #endif
jksoft 0:0a2f634d3324 246
jksoft 0:0a2f634d3324 247 #if MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 248 bool pubrel;
jksoft 0:0a2f634d3324 249 #if !defined(MAX_INCOMING_QOS2_MESSAGES)
jksoft 0:0a2f634d3324 250 #define MAX_INCOMING_QOS2_MESSAGES 10
jksoft 0:0a2f634d3324 251 #endif
jksoft 0:0a2f634d3324 252 unsigned short incomingQoS2messages[MAX_INCOMING_QOS2_MESSAGES];
jksoft 0:0a2f634d3324 253 bool isQoS2msgidFree(unsigned short id);
jksoft 0:0a2f634d3324 254 bool useQoS2msgid(unsigned short id);
jksoft 0:0a2f634d3324 255 void freeQoS2msgid(unsigned short id);
jksoft 0:0a2f634d3324 256 #endif
jksoft 0:0a2f634d3324 257
jksoft 0:0a2f634d3324 258 };
jksoft 0:0a2f634d3324 259
jksoft 0:0a2f634d3324 260 }
jksoft 0:0a2f634d3324 261
jksoft 0:0a2f634d3324 262
jksoft 0:0a2f634d3324 263 template<class Network, class Timer, int a, int MAX_MESSAGE_HANDLERS>
jksoft 0:0a2f634d3324 264 void MQTT::Client<Network, Timer, a, MAX_MESSAGE_HANDLERS>::cleanSession()
jksoft 0:0a2f634d3324 265 {
jksoft 0:0a2f634d3324 266 ping_outstanding = false;
jksoft 0:0a2f634d3324 267 for (int i = 0; i < MAX_MESSAGE_HANDLERS; ++i)
jksoft 0:0a2f634d3324 268 messageHandlers[i].topicFilter = 0;
jksoft 0:0a2f634d3324 269 isconnected = false;
jksoft 0:0a2f634d3324 270
jksoft 0:0a2f634d3324 271 #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 272 inflightMsgid = 0;
jksoft 0:0a2f634d3324 273 inflightQoS = QOS0;
jksoft 0:0a2f634d3324 274 #endif
jksoft 0:0a2f634d3324 275
jksoft 0:0a2f634d3324 276 #if MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 277 pubrel = false;
jksoft 0:0a2f634d3324 278 for (int i = 0; i < MAX_INCOMING_QOS2_MESSAGES; ++i)
jksoft 0:0a2f634d3324 279 incomingQoS2messages[i] = 0;
jksoft 0:0a2f634d3324 280 #endif
jksoft 0:0a2f634d3324 281 }
jksoft 0:0a2f634d3324 282
jksoft 0:0a2f634d3324 283
jksoft 0:0a2f634d3324 284 template<class Network, class Timer, int a, int MAX_MESSAGE_HANDLERS>
jksoft 0:0a2f634d3324 285 MQTT::Client<Network, Timer, a, MAX_MESSAGE_HANDLERS>::Client(Network& network, unsigned int command_timeout_ms) : ipstack(network), packetid()
jksoft 0:0a2f634d3324 286 {
jksoft 0:0a2f634d3324 287 last_sent = Timer();
jksoft 0:0a2f634d3324 288 last_received = Timer();
jksoft 0:0a2f634d3324 289 this->command_timeout_ms = command_timeout_ms;
jksoft 0:0a2f634d3324 290 cleanSession();
jksoft 0:0a2f634d3324 291 }
jksoft 0:0a2f634d3324 292
jksoft 0:0a2f634d3324 293
jksoft 0:0a2f634d3324 294 #if MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 295 template<class Network, class Timer, int a, int b>
jksoft 0:0a2f634d3324 296 bool MQTT::Client<Network, Timer, a, b>::isQoS2msgidFree(unsigned short id)
jksoft 0:0a2f634d3324 297 {
jksoft 0:0a2f634d3324 298 for (int i = 0; i < MAX_INCOMING_QOS2_MESSAGES; ++i)
jksoft 0:0a2f634d3324 299 {
jksoft 0:0a2f634d3324 300 if (incomingQoS2messages[i] == id)
jksoft 0:0a2f634d3324 301 return false;
jksoft 0:0a2f634d3324 302 }
jksoft 0:0a2f634d3324 303 return true;
jksoft 0:0a2f634d3324 304 }
jksoft 0:0a2f634d3324 305
jksoft 0:0a2f634d3324 306
jksoft 0:0a2f634d3324 307 template<class Network, class Timer, int a, int b>
jksoft 0:0a2f634d3324 308 bool MQTT::Client<Network, Timer, a, b>::useQoS2msgid(unsigned short id)
jksoft 0:0a2f634d3324 309 {
jksoft 0:0a2f634d3324 310 for (int i = 0; i < MAX_INCOMING_QOS2_MESSAGES; ++i)
jksoft 0:0a2f634d3324 311 {
jksoft 0:0a2f634d3324 312 if (incomingQoS2messages[i] == 0)
jksoft 0:0a2f634d3324 313 {
jksoft 0:0a2f634d3324 314 incomingQoS2messages[i] = id;
jksoft 0:0a2f634d3324 315 return true;
jksoft 0:0a2f634d3324 316 }
jksoft 0:0a2f634d3324 317 }
jksoft 0:0a2f634d3324 318 return false;
jksoft 0:0a2f634d3324 319 }
jksoft 0:0a2f634d3324 320
jksoft 0:0a2f634d3324 321
jksoft 0:0a2f634d3324 322 template<class Network, class Timer, int a, int b>
jksoft 0:0a2f634d3324 323 void MQTT::Client<Network, Timer, a, b>::freeQoS2msgid(unsigned short id)
jksoft 0:0a2f634d3324 324 {
jksoft 0:0a2f634d3324 325 for (int i = 0; i < MAX_INCOMING_QOS2_MESSAGES; ++i)
jksoft 0:0a2f634d3324 326 {
jksoft 0:0a2f634d3324 327 if (incomingQoS2messages[i] == id)
jksoft 0:0a2f634d3324 328 {
jksoft 0:0a2f634d3324 329 incomingQoS2messages[i] = 0;
jksoft 0:0a2f634d3324 330 return;
jksoft 0:0a2f634d3324 331 }
jksoft 0:0a2f634d3324 332 }
jksoft 0:0a2f634d3324 333 }
jksoft 0:0a2f634d3324 334 #endif
jksoft 0:0a2f634d3324 335
jksoft 0:0a2f634d3324 336
jksoft 0:0a2f634d3324 337 template<class Network, class Timer, int a, int b>
jksoft 0:0a2f634d3324 338 int MQTT::Client<Network, Timer, a, b>::sendPacket(int length, Timer& timer)
jksoft 0:0a2f634d3324 339 {
jksoft 0:0a2f634d3324 340 int rc = FAILURE,
jksoft 0:0a2f634d3324 341 sent = 0;
jksoft 0:0a2f634d3324 342
jksoft 0:0a2f634d3324 343 while (sent < length && !timer.expired())
jksoft 0:0a2f634d3324 344 {
jksoft 0:0a2f634d3324 345 rc = ipstack.write(&sendbuf[sent], length - sent, timer.left_ms());
jksoft 0:0a2f634d3324 346 if (rc < 0) // there was an error writing the data
jksoft 0:0a2f634d3324 347 break;
jksoft 0:0a2f634d3324 348 sent += rc;
jksoft 0:0a2f634d3324 349 }
jksoft 0:0a2f634d3324 350 if (sent == length)
jksoft 0:0a2f634d3324 351 {
jksoft 0:0a2f634d3324 352 if (this->keepAliveInterval > 0)
jksoft 0:0a2f634d3324 353 last_sent.countdown(this->keepAliveInterval); // record the fact that we have successfully sent the packet
jksoft 0:0a2f634d3324 354 rc = SUCCESS;
jksoft 0:0a2f634d3324 355 }
jksoft 0:0a2f634d3324 356 else
jksoft 0:0a2f634d3324 357 rc = FAILURE;
jksoft 0:0a2f634d3324 358
jksoft 0:0a2f634d3324 359 #if defined(MQTT_DEBUG)
jksoft 0:0a2f634d3324 360 char printbuf[150];
jksoft 0:0a2f634d3324 361 DEBUG("Rc %d from sending packet %s\n", rc, MQTTFormat_toServerString(printbuf, sizeof(printbuf), sendbuf, length));
jksoft 0:0a2f634d3324 362 #endif
jksoft 0:0a2f634d3324 363 return rc;
jksoft 0:0a2f634d3324 364 }
jksoft 0:0a2f634d3324 365
jksoft 0:0a2f634d3324 366
jksoft 0:0a2f634d3324 367 template<class Network, class Timer, int a, int b>
jksoft 0:0a2f634d3324 368 int MQTT::Client<Network, Timer, a, b>::decodePacket(int* value, int timeout)
jksoft 0:0a2f634d3324 369 {
jksoft 0:0a2f634d3324 370 unsigned char c;
jksoft 0:0a2f634d3324 371 int multiplier = 1;
jksoft 0:0a2f634d3324 372 int len = 0;
jksoft 0:0a2f634d3324 373 const int MAX_NO_OF_REMAINING_LENGTH_BYTES = 4;
jksoft 0:0a2f634d3324 374
jksoft 0:0a2f634d3324 375 *value = 0;
jksoft 0:0a2f634d3324 376 do
jksoft 0:0a2f634d3324 377 {
jksoft 0:0a2f634d3324 378 int rc = MQTTPACKET_READ_ERROR;
jksoft 0:0a2f634d3324 379
jksoft 0:0a2f634d3324 380 if (++len > MAX_NO_OF_REMAINING_LENGTH_BYTES)
jksoft 0:0a2f634d3324 381 {
jksoft 0:0a2f634d3324 382 rc = MQTTPACKET_READ_ERROR; /* bad data */
jksoft 0:0a2f634d3324 383 goto exit;
jksoft 0:0a2f634d3324 384 }
jksoft 0:0a2f634d3324 385 rc = ipstack.read(&c, 1, timeout);
jksoft 0:0a2f634d3324 386 if (rc != 1)
jksoft 0:0a2f634d3324 387 goto exit;
jksoft 0:0a2f634d3324 388 *value += (c & 127) * multiplier;
jksoft 0:0a2f634d3324 389 multiplier *= 128;
jksoft 0:0a2f634d3324 390 } while ((c & 128) != 0);
jksoft 0:0a2f634d3324 391 exit:
jksoft 0:0a2f634d3324 392 return len;
jksoft 0:0a2f634d3324 393 }
jksoft 0:0a2f634d3324 394
jksoft 0:0a2f634d3324 395
jksoft 0:0a2f634d3324 396 /**
jksoft 0:0a2f634d3324 397 * If any read fails in this method, then we should disconnect from the network, as on reconnect
jksoft 0:0a2f634d3324 398 * the packets can be retried.
jksoft 0:0a2f634d3324 399 * @param timeout the max time to wait for the packet read to complete, in milliseconds
jksoft 0:0a2f634d3324 400 * @return the MQTT packet type, or -1 if none
jksoft 0:0a2f634d3324 401 */
jksoft 0:0a2f634d3324 402 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b>
jksoft 0:0a2f634d3324 403 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::readPacket(Timer& timer)
jksoft 0:0a2f634d3324 404 {
jksoft 0:0a2f634d3324 405 int rc = FAILURE;
jksoft 0:0a2f634d3324 406 MQTTHeader header = {0};
jksoft 0:0a2f634d3324 407 int len = 0;
jksoft 0:0a2f634d3324 408 int rem_len = 0;
jksoft 0:0a2f634d3324 409
jksoft 0:0a2f634d3324 410 /* 1. read the header byte. This has the packet type in it */
jksoft 0:0a2f634d3324 411 if (ipstack.read(readbuf, 1, timer.left_ms()) != 1)
jksoft 0:0a2f634d3324 412 goto exit;
jksoft 0:0a2f634d3324 413
jksoft 0:0a2f634d3324 414 len = 1;
jksoft 0:0a2f634d3324 415 /* 2. read the remaining length. This is variable in itself */
jksoft 0:0a2f634d3324 416 decodePacket(&rem_len, timer.left_ms());
jksoft 0:0a2f634d3324 417 len += MQTTPacket_encode(readbuf + 1, rem_len); /* put the original remaining length into the buffer */
jksoft 0:0a2f634d3324 418
jksoft 0:0a2f634d3324 419 if (rem_len > (MAX_MQTT_PACKET_SIZE - len))
jksoft 0:0a2f634d3324 420 {
jksoft 0:0a2f634d3324 421 rc = BUFFER_OVERFLOW;
jksoft 0:0a2f634d3324 422 goto exit;
jksoft 0:0a2f634d3324 423 }
jksoft 0:0a2f634d3324 424
jksoft 0:0a2f634d3324 425 /* 3. read the rest of the buffer using a callback to supply the rest of the data */
jksoft 0:0a2f634d3324 426 if (rem_len > 0 && (ipstack.read(readbuf + len, rem_len, timer.left_ms()) != rem_len))
jksoft 0:0a2f634d3324 427 goto exit;
jksoft 0:0a2f634d3324 428
jksoft 0:0a2f634d3324 429 header.byte = readbuf[0];
jksoft 0:0a2f634d3324 430 rc = header.bits.type;
jksoft 0:0a2f634d3324 431 if (this->keepAliveInterval > 0)
jksoft 0:0a2f634d3324 432 last_received.countdown(this->keepAliveInterval); // record the fact that we have successfully received a packet
jksoft 0:0a2f634d3324 433 exit:
jksoft 0:0a2f634d3324 434
jksoft 0:0a2f634d3324 435 #if defined(MQTT_DEBUG)
jksoft 0:0a2f634d3324 436 if (rc >= 0)
jksoft 0:0a2f634d3324 437 {
jksoft 0:0a2f634d3324 438 char printbuf[50];
jksoft 0:0a2f634d3324 439 DEBUG("Rc %d from receiving packet %s\n", rc, MQTTFormat_toClientString(printbuf, sizeof(printbuf), readbuf, len));
jksoft 0:0a2f634d3324 440 }
jksoft 0:0a2f634d3324 441 #endif
jksoft 0:0a2f634d3324 442 return rc;
jksoft 0:0a2f634d3324 443 }
jksoft 0:0a2f634d3324 444
jksoft 0:0a2f634d3324 445
jksoft 0:0a2f634d3324 446 // assume topic filter and name is in correct format
jksoft 0:0a2f634d3324 447 // # can only be at end
jksoft 0:0a2f634d3324 448 // + and # can only be next to separator
jksoft 0:0a2f634d3324 449 template<class Network, class Timer, int a, int b>
jksoft 0:0a2f634d3324 450 bool MQTT::Client<Network, Timer, a, b>::isTopicMatched(char* topicFilter, MQTTString& topicName)
jksoft 0:0a2f634d3324 451 {
jksoft 0:0a2f634d3324 452 char* curf = topicFilter;
jksoft 0:0a2f634d3324 453 char* curn = topicName.lenstring.data;
jksoft 0:0a2f634d3324 454 char* curn_end = curn + topicName.lenstring.len;
jksoft 0:0a2f634d3324 455
jksoft 0:0a2f634d3324 456 while (*curf && curn < curn_end)
jksoft 0:0a2f634d3324 457 {
jksoft 0:0a2f634d3324 458 if (*curn == '/' && *curf != '/')
jksoft 0:0a2f634d3324 459 break;
jksoft 0:0a2f634d3324 460 if (*curf != '+' && *curf != '#' && *curf != *curn)
jksoft 0:0a2f634d3324 461 break;
jksoft 0:0a2f634d3324 462 if (*curf == '+')
jksoft 0:0a2f634d3324 463 { // skip until we meet the next separator, or end of string
jksoft 0:0a2f634d3324 464 char* nextpos = curn + 1;
jksoft 0:0a2f634d3324 465 while (nextpos < curn_end && *nextpos != '/')
jksoft 0:0a2f634d3324 466 nextpos = ++curn + 1;
jksoft 0:0a2f634d3324 467 }
jksoft 0:0a2f634d3324 468 else if (*curf == '#')
jksoft 0:0a2f634d3324 469 curn = curn_end - 1; // skip until end of string
jksoft 0:0a2f634d3324 470 curf++;
jksoft 0:0a2f634d3324 471 curn++;
jksoft 0:0a2f634d3324 472 };
jksoft 0:0a2f634d3324 473
jksoft 0:0a2f634d3324 474 return (curn == curn_end) && (*curf == '\0');
jksoft 0:0a2f634d3324 475 }
jksoft 0:0a2f634d3324 476
jksoft 0:0a2f634d3324 477
jksoft 0:0a2f634d3324 478
jksoft 0:0a2f634d3324 479 template<class Network, class Timer, int a, int MAX_MESSAGE_HANDLERS>
jksoft 0:0a2f634d3324 480 int MQTT::Client<Network, Timer, a, MAX_MESSAGE_HANDLERS>::deliverMessage(MQTTString& topicName, Message& message)
jksoft 0:0a2f634d3324 481 {
jksoft 0:0a2f634d3324 482 int rc = FAILURE;
jksoft 0:0a2f634d3324 483
jksoft 0:0a2f634d3324 484 // we have to find the right message handler - indexed by topic
jksoft 0:0a2f634d3324 485 for (int i = 0; i < MAX_MESSAGE_HANDLERS; ++i)
jksoft 0:0a2f634d3324 486 {
jksoft 0:0a2f634d3324 487 if (messageHandlers[i].topicFilter != 0 && (MQTTPacket_equals(&topicName, (char*)messageHandlers[i].topicFilter) ||
jksoft 0:0a2f634d3324 488 isTopicMatched((char*)messageHandlers[i].topicFilter, topicName)))
jksoft 0:0a2f634d3324 489 {
jksoft 0:0a2f634d3324 490 if (messageHandlers[i].fp.attached())
jksoft 0:0a2f634d3324 491 {
jksoft 0:0a2f634d3324 492 MessageData md(topicName, message);
jksoft 0:0a2f634d3324 493 messageHandlers[i].fp(md);
jksoft 0:0a2f634d3324 494 rc = SUCCESS;
jksoft 0:0a2f634d3324 495 }
jksoft 0:0a2f634d3324 496 }
jksoft 0:0a2f634d3324 497 }
jksoft 0:0a2f634d3324 498
jksoft 0:0a2f634d3324 499 if (rc == FAILURE && defaultMessageHandler.attached())
jksoft 0:0a2f634d3324 500 {
jksoft 0:0a2f634d3324 501 MessageData md(topicName, message);
jksoft 0:0a2f634d3324 502 defaultMessageHandler(md);
jksoft 0:0a2f634d3324 503 rc = SUCCESS;
jksoft 0:0a2f634d3324 504 }
jksoft 0:0a2f634d3324 505
jksoft 0:0a2f634d3324 506 return rc;
jksoft 0:0a2f634d3324 507 }
jksoft 0:0a2f634d3324 508
jksoft 0:0a2f634d3324 509
jksoft 0:0a2f634d3324 510
jksoft 0:0a2f634d3324 511 template<class Network, class Timer, int a, int b>
jksoft 0:0a2f634d3324 512 int MQTT::Client<Network, Timer, a, b>::yield(unsigned long timeout_ms)
jksoft 0:0a2f634d3324 513 {
jksoft 0:0a2f634d3324 514 int rc = SUCCESS;
jksoft 0:0a2f634d3324 515 Timer timer = Timer();
jksoft 0:0a2f634d3324 516
jksoft 0:0a2f634d3324 517 timer.countdown_ms(timeout_ms);
jksoft 0:0a2f634d3324 518 while (!timer.expired())
jksoft 0:0a2f634d3324 519 {
jksoft 0:0a2f634d3324 520 if (cycle(timer) < 0)
jksoft 0:0a2f634d3324 521 {
jksoft 0:0a2f634d3324 522 rc = FAILURE;
jksoft 0:0a2f634d3324 523 break;
jksoft 0:0a2f634d3324 524 }
jksoft 0:0a2f634d3324 525 Thread::wait(10);
jksoft 0:0a2f634d3324 526 }
jksoft 0:0a2f634d3324 527
jksoft 0:0a2f634d3324 528 return rc;
jksoft 0:0a2f634d3324 529 }
jksoft 0:0a2f634d3324 530
jksoft 0:0a2f634d3324 531
jksoft 0:0a2f634d3324 532 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b>
jksoft 0:0a2f634d3324 533 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::cycle(Timer& timer)
jksoft 0:0a2f634d3324 534 {
jksoft 0:0a2f634d3324 535 /* get one piece of work off the wire and one pass through */
jksoft 0:0a2f634d3324 536
jksoft 0:0a2f634d3324 537 // read the socket, see what work is due
jksoft 0:0a2f634d3324 538 int packet_type = readPacket(timer);
jksoft 0:0a2f634d3324 539
jksoft 0:0a2f634d3324 540 int len = 0,
jksoft 0:0a2f634d3324 541 rc = SUCCESS;
jksoft 0:0a2f634d3324 542
jksoft 0:0a2f634d3324 543 switch (packet_type)
jksoft 0:0a2f634d3324 544 {
jksoft 0:0a2f634d3324 545 case FAILURE:
jksoft 0:0a2f634d3324 546 case BUFFER_OVERFLOW:
jksoft 0:0a2f634d3324 547 rc = packet_type;
jksoft 0:0a2f634d3324 548 break;
jksoft 0:0a2f634d3324 549 case CONNACK:
jksoft 0:0a2f634d3324 550 case PUBACK:
jksoft 0:0a2f634d3324 551 case SUBACK:
jksoft 0:0a2f634d3324 552 break;
jksoft 0:0a2f634d3324 553 case PUBLISH:
jksoft 0:0a2f634d3324 554 {
jksoft 0:0a2f634d3324 555 MQTTString topicName = MQTTString_initializer;
jksoft 0:0a2f634d3324 556 Message msg;
jksoft 0:0a2f634d3324 557 int intQoS;
jksoft 0:0a2f634d3324 558 if (MQTTDeserialize_publish((unsigned char*)&msg.dup, &intQoS, (unsigned char*)&msg.retained, (unsigned short*)&msg.id, &topicName,
jksoft 0:0a2f634d3324 559 (unsigned char**)&msg.payload, (int*)&msg.payloadlen, readbuf, MAX_MQTT_PACKET_SIZE) != 1)
jksoft 0:0a2f634d3324 560 goto exit;
jksoft 0:0a2f634d3324 561 msg.qos = (enum QoS)intQoS;
jksoft 0:0a2f634d3324 562 #if MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 563 if (msg.qos != QOS2)
jksoft 0:0a2f634d3324 564 #endif
jksoft 0:0a2f634d3324 565 deliverMessage(topicName, msg);
jksoft 0:0a2f634d3324 566 #if MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 567 else if (isQoS2msgidFree(msg.id))
jksoft 0:0a2f634d3324 568 {
jksoft 0:0a2f634d3324 569 if (useQoS2msgid(msg.id))
jksoft 0:0a2f634d3324 570 deliverMessage(topicName, msg);
jksoft 0:0a2f634d3324 571 else
jksoft 0:0a2f634d3324 572 WARN("Maximum number of incoming QoS2 messages exceeded");
jksoft 0:0a2f634d3324 573 }
jksoft 0:0a2f634d3324 574 #endif
jksoft 0:0a2f634d3324 575 #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 576 if (msg.qos != QOS0)
jksoft 0:0a2f634d3324 577 {
jksoft 0:0a2f634d3324 578 if (msg.qos == QOS1)
jksoft 0:0a2f634d3324 579 len = MQTTSerialize_ack(sendbuf, MAX_MQTT_PACKET_SIZE, PUBACK, 0, msg.id);
jksoft 0:0a2f634d3324 580 else if (msg.qos == QOS2)
jksoft 0:0a2f634d3324 581 len = MQTTSerialize_ack(sendbuf, MAX_MQTT_PACKET_SIZE, PUBREC, 0, msg.id);
jksoft 0:0a2f634d3324 582 if (len <= 0)
jksoft 0:0a2f634d3324 583 rc = FAILURE;
jksoft 0:0a2f634d3324 584 else
jksoft 0:0a2f634d3324 585 rc = sendPacket(len, timer);
jksoft 0:0a2f634d3324 586 if (rc == FAILURE)
jksoft 0:0a2f634d3324 587 goto exit; // there was a problem
jksoft 0:0a2f634d3324 588 }
jksoft 0:0a2f634d3324 589 break;
jksoft 0:0a2f634d3324 590 #endif
jksoft 0:0a2f634d3324 591 }
jksoft 0:0a2f634d3324 592 #if MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 593 case PUBREC:
jksoft 0:0a2f634d3324 594 case PUBREL:
jksoft 0:0a2f634d3324 595 unsigned short mypacketid;
jksoft 0:0a2f634d3324 596 unsigned char dup, type;
jksoft 0:0a2f634d3324 597 if (MQTTDeserialize_ack(&type, &dup, &mypacketid, readbuf, MAX_MQTT_PACKET_SIZE) != 1)
jksoft 0:0a2f634d3324 598 rc = FAILURE;
jksoft 0:0a2f634d3324 599 else if ((len = MQTTSerialize_ack(sendbuf, MAX_MQTT_PACKET_SIZE,
jksoft 0:0a2f634d3324 600 (packet_type == PUBREC) ? PUBREL : PUBCOMP, 0, mypacketid)) <= 0)
jksoft 0:0a2f634d3324 601 rc = FAILURE;
jksoft 0:0a2f634d3324 602 else if ((rc = sendPacket(len, timer)) != SUCCESS) // send the PUBREL packet
jksoft 0:0a2f634d3324 603 rc = FAILURE; // there was a problem
jksoft 0:0a2f634d3324 604 if (rc == FAILURE)
jksoft 0:0a2f634d3324 605 goto exit; // there was a problem
jksoft 0:0a2f634d3324 606 if (packet_type == PUBREL)
jksoft 0:0a2f634d3324 607 freeQoS2msgid(mypacketid);
jksoft 0:0a2f634d3324 608 break;
jksoft 0:0a2f634d3324 609
jksoft 0:0a2f634d3324 610 case PUBCOMP:
jksoft 0:0a2f634d3324 611 break;
jksoft 0:0a2f634d3324 612 #endif
jksoft 0:0a2f634d3324 613 case PINGRESP:
jksoft 0:0a2f634d3324 614 ping_outstanding = false;
jksoft 0:0a2f634d3324 615 break;
jksoft 0:0a2f634d3324 616 }
jksoft 0:0a2f634d3324 617 keepalive();
jksoft 0:0a2f634d3324 618 exit:
jksoft 0:0a2f634d3324 619 if (rc == SUCCESS)
jksoft 0:0a2f634d3324 620 rc = packet_type;
jksoft 0:0a2f634d3324 621 return rc;
jksoft 0:0a2f634d3324 622 }
jksoft 0:0a2f634d3324 623
jksoft 0:0a2f634d3324 624
jksoft 0:0a2f634d3324 625 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b>
jksoft 0:0a2f634d3324 626 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::keepalive()
jksoft 0:0a2f634d3324 627 {
jksoft 0:0a2f634d3324 628 int rc = FAILURE;
jksoft 0:0a2f634d3324 629
jksoft 0:0a2f634d3324 630 if (keepAliveInterval == 0)
jksoft 0:0a2f634d3324 631 {
jksoft 0:0a2f634d3324 632 rc = SUCCESS;
jksoft 0:0a2f634d3324 633 goto exit;
jksoft 0:0a2f634d3324 634 }
jksoft 0:0a2f634d3324 635
jksoft 0:0a2f634d3324 636 if (last_sent.expired() || last_received.expired())
jksoft 0:0a2f634d3324 637 {
jksoft 0:0a2f634d3324 638 if (!ping_outstanding)
jksoft 0:0a2f634d3324 639 {
jksoft 0:0a2f634d3324 640 Timer timer(1000);
jksoft 0:0a2f634d3324 641 int len = MQTTSerialize_pingreq(sendbuf, MAX_MQTT_PACKET_SIZE);
jksoft 0:0a2f634d3324 642 if (len > 0 && (rc = sendPacket(len, timer)) == SUCCESS) // send the ping packet
jksoft 0:0a2f634d3324 643 ping_outstanding = true;
jksoft 0:0a2f634d3324 644 }
jksoft 0:0a2f634d3324 645 }
jksoft 0:0a2f634d3324 646
jksoft 0:0a2f634d3324 647 exit:
jksoft 0:0a2f634d3324 648 return rc;
jksoft 0:0a2f634d3324 649 }
jksoft 0:0a2f634d3324 650
jksoft 0:0a2f634d3324 651
jksoft 0:0a2f634d3324 652 // only used in single-threaded mode where one command at a time is in process
jksoft 0:0a2f634d3324 653 template<class Network, class Timer, int a, int b>
jksoft 0:0a2f634d3324 654 int MQTT::Client<Network, Timer, a, b>::waitfor(int packet_type, Timer& timer)
jksoft 0:0a2f634d3324 655 {
jksoft 0:0a2f634d3324 656 int rc = FAILURE;
jksoft 0:0a2f634d3324 657
jksoft 0:0a2f634d3324 658 do
jksoft 0:0a2f634d3324 659 {
jksoft 0:0a2f634d3324 660 if (timer.expired())
jksoft 0:0a2f634d3324 661 break; // we timed out
jksoft 0:0a2f634d3324 662 }
jksoft 0:0a2f634d3324 663 while ((rc = cycle(timer)) != packet_type);
jksoft 0:0a2f634d3324 664
jksoft 0:0a2f634d3324 665 return rc;
jksoft 0:0a2f634d3324 666 }
jksoft 0:0a2f634d3324 667
jksoft 0:0a2f634d3324 668
jksoft 0:0a2f634d3324 669 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b>
jksoft 0:0a2f634d3324 670 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::connect(MQTTPacket_connectData& options)
jksoft 0:0a2f634d3324 671 {
jksoft 0:0a2f634d3324 672 Timer connect_timer(command_timeout_ms);
jksoft 0:0a2f634d3324 673 int rc = FAILURE;
jksoft 0:0a2f634d3324 674 int len = 0;
jksoft 0:0a2f634d3324 675
jksoft 0:0a2f634d3324 676 if (isconnected) // don't send connect packet again if we are already connected
jksoft 0:0a2f634d3324 677 goto exit;
jksoft 0:0a2f634d3324 678
jksoft 0:0a2f634d3324 679 this->keepAliveInterval = options.keepAliveInterval;
jksoft 0:0a2f634d3324 680 this->cleansession = options.cleansession;
jksoft 0:0a2f634d3324 681 if ((len = MQTTSerialize_connect(sendbuf, MAX_MQTT_PACKET_SIZE, &options)) <= 0)
jksoft 0:0a2f634d3324 682 goto exit;
jksoft 0:0a2f634d3324 683 if ((rc = sendPacket(len, connect_timer)) != SUCCESS) // send the connect packet
jksoft 0:0a2f634d3324 684 goto exit; // there was a problem
jksoft 0:0a2f634d3324 685
jksoft 0:0a2f634d3324 686 if (this->keepAliveInterval > 0)
jksoft 0:0a2f634d3324 687 last_received.countdown(this->keepAliveInterval);
jksoft 0:0a2f634d3324 688 // this will be a blocking call, wait for the connack
jksoft 0:0a2f634d3324 689 if (waitfor(CONNACK, connect_timer) == CONNACK)
jksoft 0:0a2f634d3324 690 {
jksoft 0:0a2f634d3324 691 unsigned char connack_rc = 255;
jksoft 0:0a2f634d3324 692 bool sessionPresent = false;
jksoft 0:0a2f634d3324 693 if (MQTTDeserialize_connack((unsigned char*)&sessionPresent, &connack_rc, readbuf, MAX_MQTT_PACKET_SIZE) == 1)
jksoft 0:0a2f634d3324 694 rc = connack_rc;
jksoft 0:0a2f634d3324 695 else
jksoft 0:0a2f634d3324 696 rc = FAILURE;
jksoft 0:0a2f634d3324 697 }
jksoft 0:0a2f634d3324 698 else
jksoft 0:0a2f634d3324 699 rc = FAILURE;
jksoft 0:0a2f634d3324 700
jksoft 0:0a2f634d3324 701 #if MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 702 // resend any inflight publish
jksoft 0:0a2f634d3324 703 if (inflightMsgid > 0 && inflightQoS == QOS2 && pubrel)
jksoft 0:0a2f634d3324 704 {
jksoft 0:0a2f634d3324 705 if ((len = MQTTSerialize_ack(sendbuf, MAX_MQTT_PACKET_SIZE, PUBREL, 0, inflightMsgid)) <= 0)
jksoft 0:0a2f634d3324 706 rc = FAILURE;
jksoft 0:0a2f634d3324 707 else
jksoft 0:0a2f634d3324 708 rc = publish(len, connect_timer, inflightQoS);
jksoft 0:0a2f634d3324 709 }
jksoft 0:0a2f634d3324 710 else
jksoft 0:0a2f634d3324 711 #endif
jksoft 0:0a2f634d3324 712 #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 713 if (inflightMsgid > 0)
jksoft 0:0a2f634d3324 714 {
jksoft 0:0a2f634d3324 715 memcpy(sendbuf, pubbuf, MAX_MQTT_PACKET_SIZE);
jksoft 0:0a2f634d3324 716 rc = publish(inflightLen, connect_timer, inflightQoS);
jksoft 0:0a2f634d3324 717 }
jksoft 0:0a2f634d3324 718 #endif
jksoft 0:0a2f634d3324 719
jksoft 0:0a2f634d3324 720 exit:
jksoft 0:0a2f634d3324 721 if (rc == SUCCESS)
jksoft 0:0a2f634d3324 722 isconnected = true;
jksoft 0:0a2f634d3324 723 return rc;
jksoft 0:0a2f634d3324 724 }
jksoft 0:0a2f634d3324 725
jksoft 0:0a2f634d3324 726
jksoft 0:0a2f634d3324 727 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b>
jksoft 0:0a2f634d3324 728 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::connect()
jksoft 0:0a2f634d3324 729 {
jksoft 0:0a2f634d3324 730 MQTTPacket_connectData default_options = MQTTPacket_connectData_initializer;
jksoft 0:0a2f634d3324 731 return connect(default_options);
jksoft 0:0a2f634d3324 732 }
jksoft 0:0a2f634d3324 733
jksoft 0:0a2f634d3324 734
jksoft 0:0a2f634d3324 735 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int MAX_MESSAGE_HANDLERS>
jksoft 0:0a2f634d3324 736 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, MAX_MESSAGE_HANDLERS>::subscribe(const char* topicFilter, enum QoS qos, messageHandler messageHandler)
jksoft 0:0a2f634d3324 737 {
jksoft 0:0a2f634d3324 738 int rc = FAILURE;
jksoft 0:0a2f634d3324 739 Timer timer(command_timeout_ms);
jksoft 0:0a2f634d3324 740 int len = 0;
jksoft 0:0a2f634d3324 741 MQTTString topic = {(char*)topicFilter, {0, 0}};
jksoft 0:0a2f634d3324 742
jksoft 0:0a2f634d3324 743 if (!isconnected)
jksoft 0:0a2f634d3324 744 goto exit;
jksoft 0:0a2f634d3324 745
jksoft 0:0a2f634d3324 746 len = MQTTSerialize_subscribe(sendbuf, MAX_MQTT_PACKET_SIZE, 0, packetid.getNext(), 1, &topic, (int*)&qos);
jksoft 0:0a2f634d3324 747 if (len <= 0)
jksoft 0:0a2f634d3324 748 goto exit;
jksoft 0:0a2f634d3324 749 if ((rc = sendPacket(len, timer)) != SUCCESS) // send the subscribe packet
jksoft 0:0a2f634d3324 750 goto exit; // there was a problem
jksoft 0:0a2f634d3324 751
jksoft 0:0a2f634d3324 752 if (waitfor(SUBACK, timer) == SUBACK) // wait for suback
jksoft 0:0a2f634d3324 753 {
jksoft 0:0a2f634d3324 754 int count = 0, grantedQoS = -1;
jksoft 0:0a2f634d3324 755 unsigned short mypacketid;
jksoft 0:0a2f634d3324 756 if (MQTTDeserialize_suback(&mypacketid, 1, &count, &grantedQoS, readbuf, MAX_MQTT_PACKET_SIZE) == 1)
jksoft 0:0a2f634d3324 757 rc = grantedQoS; // 0, 1, 2 or 0x80
jksoft 0:0a2f634d3324 758 if (rc != 0x80)
jksoft 0:0a2f634d3324 759 {
jksoft 0:0a2f634d3324 760 for (int i = 0; i < MAX_MESSAGE_HANDLERS; ++i)
jksoft 0:0a2f634d3324 761 {
jksoft 0:0a2f634d3324 762 if (messageHandlers[i].topicFilter == 0)
jksoft 0:0a2f634d3324 763 {
jksoft 0:0a2f634d3324 764 messageHandlers[i].topicFilter = topicFilter;
jksoft 0:0a2f634d3324 765 messageHandlers[i].fp.attach(messageHandler);
jksoft 0:0a2f634d3324 766 rc = 0;
jksoft 0:0a2f634d3324 767 break;
jksoft 0:0a2f634d3324 768 }
jksoft 0:0a2f634d3324 769 }
jksoft 0:0a2f634d3324 770 }
jksoft 0:0a2f634d3324 771 }
jksoft 0:0a2f634d3324 772 else
jksoft 0:0a2f634d3324 773 rc = FAILURE;
jksoft 0:0a2f634d3324 774
jksoft 0:0a2f634d3324 775 exit:
jksoft 0:0a2f634d3324 776 if (rc != SUCCESS)
jksoft 0:0a2f634d3324 777 cleanSession();
jksoft 0:0a2f634d3324 778 return rc;
jksoft 0:0a2f634d3324 779 }
jksoft 0:0a2f634d3324 780
jksoft 0:0a2f634d3324 781
jksoft 0:0a2f634d3324 782 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int MAX_MESSAGE_HANDLERS>
jksoft 0:0a2f634d3324 783 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, MAX_MESSAGE_HANDLERS>::unsubscribe(const char* topicFilter)
jksoft 0:0a2f634d3324 784 {
jksoft 0:0a2f634d3324 785 int rc = FAILURE;
jksoft 0:0a2f634d3324 786 Timer timer(command_timeout_ms);
jksoft 0:0a2f634d3324 787 MQTTString topic = {(char*)topicFilter, {0, 0}};
jksoft 0:0a2f634d3324 788 int len = 0;
jksoft 0:0a2f634d3324 789
jksoft 0:0a2f634d3324 790 if (!isconnected)
jksoft 0:0a2f634d3324 791 goto exit;
jksoft 0:0a2f634d3324 792
jksoft 0:0a2f634d3324 793 if ((len = MQTTSerialize_unsubscribe(sendbuf, MAX_MQTT_PACKET_SIZE, 0, packetid.getNext(), 1, &topic)) <= 0)
jksoft 0:0a2f634d3324 794 goto exit;
jksoft 0:0a2f634d3324 795 if ((rc = sendPacket(len, timer)) != SUCCESS) // send the unsubscribe packet
jksoft 0:0a2f634d3324 796 goto exit; // there was a problem
jksoft 0:0a2f634d3324 797
jksoft 0:0a2f634d3324 798 if (waitfor(UNSUBACK, timer) == UNSUBACK)
jksoft 0:0a2f634d3324 799 {
jksoft 0:0a2f634d3324 800 unsigned short mypacketid; // should be the same as the packetid above
jksoft 0:0a2f634d3324 801 if (MQTTDeserialize_unsuback(&mypacketid, readbuf, MAX_MQTT_PACKET_SIZE) == 1)
jksoft 0:0a2f634d3324 802 {
jksoft 0:0a2f634d3324 803 rc = 0;
jksoft 0:0a2f634d3324 804
jksoft 0:0a2f634d3324 805 // remove the subscription message handler associated with this topic, if there is one
jksoft 0:0a2f634d3324 806 for (int i = 0; i < MAX_MESSAGE_HANDLERS; ++i)
jksoft 0:0a2f634d3324 807 {
jksoft 0:0a2f634d3324 808 if (messageHandlers[i].topicFilter && strcmp(messageHandlers[i].topicFilter, topicFilter) == 0)
jksoft 0:0a2f634d3324 809 {
jksoft 0:0a2f634d3324 810 messageHandlers[i].topicFilter = 0;
jksoft 0:0a2f634d3324 811 break;
jksoft 0:0a2f634d3324 812 }
jksoft 0:0a2f634d3324 813 }
jksoft 0:0a2f634d3324 814 }
jksoft 0:0a2f634d3324 815 }
jksoft 0:0a2f634d3324 816 else
jksoft 0:0a2f634d3324 817 rc = FAILURE;
jksoft 0:0a2f634d3324 818
jksoft 0:0a2f634d3324 819 exit:
jksoft 0:0a2f634d3324 820 if (rc != SUCCESS)
jksoft 0:0a2f634d3324 821 cleanSession();
jksoft 0:0a2f634d3324 822 return rc;
jksoft 0:0a2f634d3324 823 }
jksoft 0:0a2f634d3324 824
jksoft 0:0a2f634d3324 825
jksoft 0:0a2f634d3324 826 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b>
jksoft 0:0a2f634d3324 827 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::publish(int len, Timer& timer, enum QoS qos)
jksoft 0:0a2f634d3324 828 {
jksoft 0:0a2f634d3324 829 int rc;
jksoft 0:0a2f634d3324 830
jksoft 0:0a2f634d3324 831 if ((rc = sendPacket(len, timer)) != SUCCESS) // send the publish packet
jksoft 0:0a2f634d3324 832 goto exit; // there was a problem
jksoft 0:0a2f634d3324 833
jksoft 0:0a2f634d3324 834 #if MQTTCLIENT_QOS1
jksoft 0:0a2f634d3324 835 if (qos == QOS1)
jksoft 0:0a2f634d3324 836 {
jksoft 0:0a2f634d3324 837 if (waitfor(PUBACK, timer) == PUBACK)
jksoft 0:0a2f634d3324 838 {
jksoft 0:0a2f634d3324 839 unsigned short mypacketid;
jksoft 0:0a2f634d3324 840 unsigned char dup, type;
jksoft 0:0a2f634d3324 841 if (MQTTDeserialize_ack(&type, &dup, &mypacketid, readbuf, MAX_MQTT_PACKET_SIZE) != 1)
jksoft 0:0a2f634d3324 842 rc = FAILURE;
jksoft 0:0a2f634d3324 843 else if (inflightMsgid == mypacketid)
jksoft 0:0a2f634d3324 844 inflightMsgid = 0;
jksoft 0:0a2f634d3324 845 }
jksoft 0:0a2f634d3324 846 else
jksoft 0:0a2f634d3324 847 rc = FAILURE;
jksoft 0:0a2f634d3324 848 }
jksoft 0:0a2f634d3324 849 #elif MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 850 else if (qos == QOS2)
jksoft 0:0a2f634d3324 851 {
jksoft 0:0a2f634d3324 852 if (waitfor(PUBCOMP, timer) == PUBCOMP)
jksoft 0:0a2f634d3324 853 {
jksoft 0:0a2f634d3324 854 unsigned short mypacketid;
jksoft 0:0a2f634d3324 855 unsigned char dup, type;
jksoft 0:0a2f634d3324 856 if (MQTTDeserialize_ack(&type, &dup, &mypacketid, readbuf, MAX_MQTT_PACKET_SIZE) != 1)
jksoft 0:0a2f634d3324 857 rc = FAILURE;
jksoft 0:0a2f634d3324 858 else if (inflightMsgid == mypacketid)
jksoft 0:0a2f634d3324 859 inflightMsgid = 0;
jksoft 0:0a2f634d3324 860 }
jksoft 0:0a2f634d3324 861 else
jksoft 0:0a2f634d3324 862 rc = FAILURE;
jksoft 0:0a2f634d3324 863 }
jksoft 0:0a2f634d3324 864 #endif
jksoft 0:0a2f634d3324 865
jksoft 0:0a2f634d3324 866 exit:
jksoft 0:0a2f634d3324 867 if (rc != SUCCESS)
jksoft 0:0a2f634d3324 868 cleanSession();
jksoft 0:0a2f634d3324 869 return rc;
jksoft 0:0a2f634d3324 870 }
jksoft 0:0a2f634d3324 871
jksoft 0:0a2f634d3324 872
jksoft 0:0a2f634d3324 873
jksoft 0:0a2f634d3324 874 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b>
jksoft 0:0a2f634d3324 875 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::publish(const char* topicName, void* payload, size_t payloadlen, unsigned short& id, enum QoS qos, bool retained)
jksoft 0:0a2f634d3324 876 {
jksoft 0:0a2f634d3324 877 int rc = FAILURE;
jksoft 0:0a2f634d3324 878 Timer timer(command_timeout_ms);
jksoft 0:0a2f634d3324 879 MQTTString topicString = MQTTString_initializer;
jksoft 0:0a2f634d3324 880 int len = 0;
jksoft 0:0a2f634d3324 881
jksoft 0:0a2f634d3324 882 if (!isconnected)
jksoft 0:0a2f634d3324 883 goto exit;
jksoft 0:0a2f634d3324 884
jksoft 0:0a2f634d3324 885 topicString.cstring = (char*)topicName;
jksoft 0:0a2f634d3324 886
jksoft 0:0a2f634d3324 887 #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 888 if (qos == QOS1 || qos == QOS2)
jksoft 0:0a2f634d3324 889 id = packetid.getNext();
jksoft 0:0a2f634d3324 890 #endif
jksoft 0:0a2f634d3324 891
jksoft 0:0a2f634d3324 892 len = MQTTSerialize_publish(sendbuf, MAX_MQTT_PACKET_SIZE, 0, qos, retained, id,
jksoft 0:0a2f634d3324 893 topicString, (unsigned char*)payload, payloadlen);
jksoft 0:0a2f634d3324 894 if (len <= 0)
jksoft 0:0a2f634d3324 895 goto exit;
jksoft 0:0a2f634d3324 896
jksoft 0:0a2f634d3324 897 #if MQTTCLIENT_QOS1 || MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 898 if (!cleansession)
jksoft 0:0a2f634d3324 899 {
jksoft 0:0a2f634d3324 900 memcpy(pubbuf, sendbuf, len);
jksoft 0:0a2f634d3324 901 inflightMsgid = id;
jksoft 0:0a2f634d3324 902 inflightLen = len;
jksoft 0:0a2f634d3324 903 inflightQoS = qos;
jksoft 0:0a2f634d3324 904 #if MQTTCLIENT_QOS2
jksoft 0:0a2f634d3324 905 pubrel = false;
jksoft 0:0a2f634d3324 906 #endif
jksoft 0:0a2f634d3324 907 }
jksoft 0:0a2f634d3324 908 #endif
jksoft 0:0a2f634d3324 909
jksoft 0:0a2f634d3324 910 rc = publish(len, timer, qos);
jksoft 0:0a2f634d3324 911 exit:
jksoft 0:0a2f634d3324 912 return rc;
jksoft 0:0a2f634d3324 913 }
jksoft 0:0a2f634d3324 914
jksoft 0:0a2f634d3324 915
jksoft 0:0a2f634d3324 916 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b>
jksoft 0:0a2f634d3324 917 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::publish(const char* topicName, void* payload, size_t payloadlen, enum QoS qos, bool retained)
jksoft 0:0a2f634d3324 918 {
jksoft 0:0a2f634d3324 919 unsigned short id = 0; // dummy - not used for anything
jksoft 0:0a2f634d3324 920 return publish(topicName, payload, payloadlen, id, qos, retained);
jksoft 0:0a2f634d3324 921 }
jksoft 0:0a2f634d3324 922
jksoft 0:0a2f634d3324 923
jksoft 0:0a2f634d3324 924 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b>
jksoft 0:0a2f634d3324 925 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::publish(const char* topicName, Message& message)
jksoft 0:0a2f634d3324 926 {
jksoft 0:0a2f634d3324 927 return publish(topicName, message.payload, message.payloadlen, message.qos, message.retained);
jksoft 0:0a2f634d3324 928 }
jksoft 0:0a2f634d3324 929
jksoft 0:0a2f634d3324 930
jksoft 0:0a2f634d3324 931 template<class Network, class Timer, int MAX_MQTT_PACKET_SIZE, int b>
jksoft 0:0a2f634d3324 932 int MQTT::Client<Network, Timer, MAX_MQTT_PACKET_SIZE, b>::disconnect()
jksoft 0:0a2f634d3324 933 {
jksoft 0:0a2f634d3324 934 int rc = FAILURE;
jksoft 0:0a2f634d3324 935 Timer timer(command_timeout_ms); // we might wait for incomplete incoming publishes to complete
jksoft 0:0a2f634d3324 936 int len = MQTTSerialize_disconnect(sendbuf, MAX_MQTT_PACKET_SIZE);
jksoft 0:0a2f634d3324 937 if (len > 0)
jksoft 0:0a2f634d3324 938 rc = sendPacket(len, timer); // send the disconnect packet
jksoft 0:0a2f634d3324 939
jksoft 0:0a2f634d3324 940 if (cleansession)
jksoft 0:0a2f634d3324 941 cleanSession();
jksoft 0:0a2f634d3324 942 else
jksoft 0:0a2f634d3324 943 isconnected = false;
jksoft 0:0a2f634d3324 944 return rc;
jksoft 0:0a2f634d3324 945 }
jksoft 0:0a2f634d3324 946
jksoft 0:0a2f634d3324 947
jksoft 0:0a2f634d3324 948 #endif