Ian Craggs / MQTTSN

High level MQTT-SN C++ library

Dependencies:   EthernetInterface FP MQTTSNPacket

Dependents:   HelloMQTTSN

MQTTSNClient.h@1:3f59a8468e46, 2015-02-26 (annotated)

Committer:
icraggs
Date:
Thu Feb 26 23:51:56 2015 +0000
Revision:
1:3f59a8468e46
Parent:
0:ae83cacd60d2 
MQTTSN high level C++ library

Who changed what in which revision?

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