smarter packet reading makes for faster publish-handling! also, retries subscriptions 3 times

Adafruit_MQTT.cpp

@@ -169,7 +169,7 @@ int8_t Adafruit_MQTT::connect() {
     return -1;
 
   // Read connect response packet and verify it
-  len = readPacket(buffer, 4, CONNECT_TIMEOUT_MS);
+  len = readFullPacket(buffer, CONNECT_TIMEOUT_MS);
   if (len != 4)
     return -1;
   if ((buffer[0] != (MQTT_CTRL_CONNECTACK << 4)) || (buffer[1] != 2))
@@ -182,23 +182,27 @@ int8_t Adafruit_MQTT::connect() {
     // Ignore subscriptions that aren't defined.
     if (subscriptions[i] == 0) continue;
 
-    // Construct and send subscription packet.
+    boolean success = false;
-    uint8_t len = subscribePacket(buffer, subscriptions[i]->topic, subscriptions[i]->qos);
+    for (uint8_t retry=0; (retry<3) && !success; retry++) { // retry until we get a suback    
-    if (!sendPacket(buffer, len))
+      // Construct and send subscription packet.
-      return -1;
+      uint8_t len = subscribePacket(buffer, subscriptions[i]->topic, subscriptions[i]->qos);
+      if (!sendPacket(buffer, len))
+	return -1;
 
-    // Check for SUBACK if using MQTT 3.1.1 or higher
+      if(MQTT_PROTOCOL_LEVEL < 3) // older versions didn't suback
-    // TODO: The Server is permitted to start sending PUBLISH packets matching the
+	break;
-    // Subscription before the Server sends the SUBACK Packet. (will really need to use callbacks - ada)
+
-    if(MQTT_PROTOCOL_LEVEL > 3) {
+      // Check for SUBACK if using MQTT 3.1.1 or higher
-       len = processPacketsUntil(buffer, MQTT_CTRL_SUBACK, CONNECT_TIMEOUT_MS);
+      // TODO: The Server is permitted to start sending PUBLISH packets matching the
-       DEBUG_PRINT(F("SubAck:\t"));
+      // Subscription before the Server sends the SUBACK Packet. (will really need to use callbacks - ada)
-       DEBUG_PRINTBUFFER(buffer, len);
+
-       if ((len != 5) || (buffer[0] != (MQTT_CTRL_SUBACK << 4))) {
+      len = processPacketsUntil(buffer, MQTT_CTRL_SUBACK, CONNECT_TIMEOUT_MS);
-         return 6;  // failure to subscribe
+      if ((len != 5) || (buffer[0] != (MQTT_CTRL_SUBACK << 4))) {
-       }
+	continue; // retry!
+      }
+      success = true;
     }
-
+    if (! success) return 6; // failed to sub for some reason
   }
 
   return 0;
@@ -208,7 +212,8 @@ uint16_t Adafruit_MQTT::processPacketsUntil(uint8_t *buffer, uint8_t waitforpack
   uint16_t len;
   while (len = readFullPacket(buffer, timeout)) {
 
-    // TODO: add subscription reading & processing here
+    //DEBUG_PRINT("Packet read size: "); DEBUG_PRINTLN(len);
+    // TODO: add subscription reading & call back processing here
 
     if ((buffer[0] >> 4) == waitforpackettype) {
       //DEBUG_PRINTLN(F("Found right packet")); 
@@ -251,7 +256,7 @@ uint16_t Adafruit_MQTT::readFullPacket(uint8_t *buffer, uint16_t timeout) {
     }
   } while (encodedByte & 0x80);
 
-  //DEBUG_PRINT(F("Packet Length:\t")); DEBUG_PRINTLN(value);
+  DEBUG_PRINT(F("Packet Length:\t")); DEBUG_PRINTLN(value);
   
   rlen = readPacket(pbuff, value, timeout);
   //DEBUG_PRINT(F("Remaining packet:\t")); DEBUG_PRINTBUFFER(pbuff, rlen);
@@ -296,7 +301,7 @@ bool Adafruit_MQTT::publish(const char *topic, uint8_t *data, uint8_t bLen, uint
 
   // If QOS level is high enough verify the response packet.
   if (qos > 0) {
-    len = readPacket(buffer, 4, PUBLISH_TIMEOUT_MS);
+    len = readFullPacket(buffer, PUBLISH_TIMEOUT_MS);
     DEBUG_PRINT(F("Publish QOS1+ reply:\t"));
     DEBUG_PRINTBUFFER(buffer, len);
     if (len != 4)
@@ -377,7 +382,7 @@ bool Adafruit_MQTT::unsubscribe(Adafruit_MQTT_Subscribe *sub) {
       if(subscriptions[i]->qos > 0 && MQTT_PROTOCOL_LEVEL > 3) {
 
         // wait for UNSUBACK
-        len = readPacket(buffer, 5, CONNECT_TIMEOUT_MS);
+        len = readFullPacket(buffer, CONNECT_TIMEOUT_MS);
         DEBUG_PRINT(F("UNSUBACK:\t"));
         DEBUG_PRINTBUFFER(buffer, len);
 
@@ -401,9 +406,10 @@ Adafruit_MQTT_Subscribe *Adafruit_MQTT::readSubscription(int16_t timeout) {
   uint8_t i, topiclen, datalen;
 
   // Check if data is available to read.
-  uint16_t len = readPacket(buffer, MAXBUFFERSIZE, timeout, true); // return one full packet
+  uint16_t len = readFullPacket(buffer, timeout); // return one full packet
   if (!len)
     return NULL;  // No data available, just quit.
+  DEBUG_PRINT("Packet len: "); DEBUG_PRINTLN(len); 
   DEBUG_PRINTBUFFER(buffer, len);
 
   // Parse out length of packet.

Adafruit_MQTT.h

@@ -200,10 +200,8 @@ class Adafruit_MQTT {
 
   // Read MQTT packet from the server.  Will read up to maxlen bytes and store
   // the data in the provided buffer.  Waits up to the specified timeout (in
-  // milliseconds) for data to be available.  If checkForValidPubPacket is true
+  // milliseconds) for data to be available. 
-  // then the received data is verified to make sure it's a complete packet.
+  virtual uint16_t readPacket(uint8_t *buffer, uint8_t maxlen, int16_t timeout) = 0;
-  virtual uint16_t readPacket(uint8_t *buffer, uint8_t maxlen, int16_t timeout,
-                              bool checkForValidPubPacket = false) = 0;
 
   // Read a full packet, keeping note of the correct length
   uint16_t readFullPacket(uint8_t *buffer, uint16_t timeout);

Adafruit_MQTT_CC3000.h

@@ -100,8 +100,7 @@ class Adafruit_MQTT_CC3000 : public Adafruit_MQTT {
     return mqttclient.connected();
   }
 
-  uint16_t readPacket(uint8_t *buffer, uint8_t maxlen, int16_t timeout,
+  uint16_t readPacket(uint8_t *buffer, uint8_t maxlen, int16_t timeout) {
-                      bool checkForValidPubPacket = false) {
     /* Read data until either the connection is closed, or the idle timeout is reached. */
     uint16_t len = 0;
     int16_t t = timeout;
@@ -120,16 +119,6 @@ class Adafruit_MQTT_CC3000 : public Adafruit_MQTT {
           DEBUG_PRINTBUFFER(buffer, len);
           return len;
         }
-
-        // special case where we just one one publication packet at a time
-        if (checkForValidPubPacket) {
-          if ((buffer[0] == (MQTT_CTRL_PUBLISH << 4)) && (buffer[1] == len-2)) {
-            // oooh a valid publish packet!
-            DEBUG_PRINT(F("Read PUBLISH packet:\t"));
-            DEBUG_PRINTBUFFER(buffer, len);
-            return len;
-          }
-        }
       }
       Watchdog.reset();
       timeout -= MQTT_CC3000_INTERAVAILDELAY;

Adafruit_MQTT_Client.cpp

@@ -48,8 +48,7 @@ bool Adafruit_MQTT_Client::connected() {
 }
 
 uint16_t Adafruit_MQTT_Client::readPacket(uint8_t *buffer, uint8_t maxlen,
-                                          int16_t timeout,
+                                          int16_t timeout) {
-                                          bool checkForValidPubPacket) {
   /* Read data until either the connection is closed, or the idle timeout is reached. */
   uint16_t len = 0;
   int16_t t = timeout;
@@ -64,20 +63,10 @@ uint16_t Adafruit_MQTT_Client::readPacket(uint8_t *buffer, uint8_t maxlen,
       //DEBUG_PRINTLN((uint8_t)c, HEX);
       len++;
       if (len == maxlen) {  // we read all we want, bail
-        DEBUG_PRINT(F("Read packet:\t"));
+        DEBUG_PRINT(F("Read data:\t"));
         DEBUG_PRINTBUFFER(buffer, len);
         return len;
       }
-
-      // special case where we just one one publication packet at a time
-      if (checkForValidPubPacket) {
-        if ((buffer[0] == (MQTT_CTRL_PUBLISH << 4)) && (buffer[1] == len-2)) {
-          // oooh a valid publish packet!
-          DEBUG_PRINT(F("Read PUBLISH packet:\t"));
-          DEBUG_PRINTBUFFER(buffer, len);
-          return len;
-        }
-      }
     }
     timeout -= MQTT_CLIENT_READINTERVAL_MS;
     delay(MQTT_CLIENT_READINTERVAL_MS);

Adafruit_MQTT_Client.h

@@ -50,8 +50,7 @@ class Adafruit_MQTT_Client : public Adafruit_MQTT {
   bool connectServer();
   bool disconnectServer();
   bool connected();
-  uint16_t readPacket(uint8_t *buffer, uint8_t maxlen, int16_t timeout,
+  uint16_t readPacket(uint8_t *buffer, uint8_t maxlen, int16_t timeout);
-                      bool checkForValidPubPacket = false);
   bool sendPacket(uint8_t *buffer, uint8_t len);
 
  private: