Release 0.9.3

strToIndex is dangerous because it can increment the use of a string, or
create a new string. This method should only be called by IndexedString.

.github/workflows/superlinter.yml

@@ -1,26 +1,52 @@
-name: Super-Linter
+---
+#################################
+#################################
+## Super Linter GitHub Actions ##
+#################################
+#################################
+name: Lint Code Base
 
-# Run this workflow every time a new commit pushed to your repository
 #
+# Documentation:
+# https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
+#
+
+#############################
+# Start the job on all push #
+#############################
 on: push
 
+###############
+# Set the Job #
+###############
 jobs:
-  # Set the job key. The key is displayed as the job name
-  # when a job name is not provided
-  super-lint:
+  build:
     # Name the Job
-    name: Lint code base
-    # Set the type of machine to run on
+    name: Lint Code Base
+    # Set the agent to run on
     runs-on: ubuntu-latest
 
+    ##################
+    # Load all steps #
+    ##################
     steps:
-      # Checks out a copy of your repository on the ubuntu-latest machine
-      - name: Checkout code
-        uses: actions/checkout@v2
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          # Full git history is needed to get a proper
+          # list of changed files within `super-linter`
+          fetch-depth: 0
 
-      # Runs the Super-Linter action
-      - name: Run Super-Linter
-        uses: github/super-linter@v3
+      ################################
+      # Run Linter against code base #
+      ################################
+      - name: Lint Code Base
+        uses: github/super-linter/slim@v4
         env:
+          VALIDATE_ALL_CODEBASE: false
+          # Change to 'master' if your main branch differs
           DEFAULT_BRANCH: main
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -12,7 +12,7 @@ TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32
 
 ## Features
 
-- Very (very !!) fast broker I saw it re-sent 1000 topics per second for two
+- Very fast broker I saw it re-sent 1000 topics per second for two
   clients that had subscribed (payload ~15 bytes ESP8266). No topic lost.
   The max I've seen was 2k msg/s (1 client 1 subscription)
 - Act as as a mqtt broker and/or a mqtt client
@@ -22,6 +22,12 @@ TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32
   proxy for clients that are connected to it.
 - zeroconf, this is a strange but very powerful mode where
   all brokers tries to connect together on the same local network.
+- small memory footprint (very efficient topic storage)
+
+## Limitations
+
+- Max of 255 different topics can be stored (change index_t type to allow more)
+- No Qos because messages are not queued but immediately sent to clients
 
 ## Quickstart
 

library.json

@@ -1,18 +0,0 @@
-{
-    "name": "TinyMqtt",
-    "keywords": "ethernet, mqtt, m2m, iot",
-    "description": "MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive and host a broker for MQTT. It does support MQTT 3.1.1 with QOS=0 on ESP8266 and ESP32 WROOM platfrms.",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/hsaturn/TinyMqtt.git"
-    },
-    "version": "0.7.9",
-    "exclude": "",
-    "examples": "examples/*/*.ino",
-    "frameworks": "arduino",
-    "platforms": [
-        "atmelavr",
-        "espressif8266",
-        "espressif32"
-    ]
-}

library.properties

@@ -1,5 +1,5 @@
 name=TinyMqtt
-version=0.7.9
+version=0.9.3
 author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
 maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
 sentence=A tiny broker and client library for MQTT messaging.
@@ -8,4 +8,3 @@ category=Communication
 url=https://github.com/hsaturn/TinyMqtt
 architectures=*
 includes=TinyMqtt.h
-depends=AsyncTCP

src/MqttStreaming.h

@@ -38,6 +38,7 @@
   4.  Simple _FMT mechanism ala printf, but without the typeunsafetyness 
       and no internal buffers for replaceable stream printing
 */
+#pragma once
 
 #ifndef ARDUINO_STREAMING
 #define ARDUINO_STREAMING

src/StringIndexer.h

@@ -28,29 +28,6 @@ class StringIndexer
   public:
     using index_t = uint8_t;
 
-		static index_t strToIndex(const char* str, uint8_t len)
-		{
-			for(auto it=strings.begin(); it!=strings.end(); it++)
-			{
-				if (strncmp(it->second.str.c_str(), str, len)==0)
-				{
-					it->second.used++;
-					return it->first;
-				}
-			}
-			for(index_t index=1; index; index++)
-			{
-				if (strings.find(index)==strings.end())
-				{
-					strings[index].str = std::string(str, len);
-					strings[index].used++;
-					// Serial << "Creating index " << index << " for (" << strings[index].str.c_str() << ") len=" << len << endl;
-					return index;
-				}
-			}
-			return 0;	// TODO out of indexes
-		}
-
    static const std::string& str(const index_t& index)
     {
       static std::string dummy;
@@ -82,6 +59,32 @@ class StringIndexer
     static uint16_t count() { return strings.size(); }
 
   private:
+    friend class IndexedString;
+
+    // increment use of str or create a new index
+    static index_t strToIndex(const char* str, uint8_t len)
+    {
+      for(auto it=strings.begin(); it!=strings.end(); it++)
+      {
+        if (it->second.str.length() == len && strcmp(it->second.str.c_str(), str)==0)
+        {
+          it->second.used++;
+          return it->first;
+        }
+      }
+      for(index_t index=1; index; index++)
+      {
+        if (strings.find(index)==strings.end())
+        {
+          strings[index].str = std::string(str, len);
+          strings[index].used++;
+          // Serial << "Creating index " << index << " for (" << strings[index].str.c_str() << ") len=" << len << endl;
+          return index;
+        }
+      }
+      return 0;  // TODO out of indexes
+    }
+
     static std::map<index_t, StringCounter> strings;
 };
 

src/TinyMqtt.cpp

@@ -1,13 +1,9 @@
 #include "TinyMqtt.h"
 #include <sstream>
 
-void outstring(const char* prefix, const char*p, uint16_t len)
-{
-	return;
-	Serial << prefix << "='";
-	while(len--) Serial << (char)*p++;
-	Serial << '\'' << endl;
-}
+#ifdef EPOXY_DUINO
+  std::map<MqttMessage::Type, int> MqttClient::counters;
+#endif
 
 MqttBroker::MqttBroker(uint16_t port)
 {
@@ -38,7 +34,11 @@ MqttClient::MqttClient(MqttBroker* parent, TcpClient* new_client)
 #else
   client = new WiFiClient(*new_client);
 #endif
-	alive = millis()+5000;	// client expires after 5s if no CONNECT msg
+#ifdef EPOXY_DUINO
+  alive = millis()+500000;
+#else
+  alive = millis()+5000;  // TODO MAGIC client expires after 5s if no CONNECT msg
+#endif
 }
 
 MqttClient::MqttClient(MqttBroker* parent, const std::string& id)
@@ -59,7 +59,7 @@ void MqttClient::close(bool bSendDisconnect)
 {
   debug("close " << id().c_str());
   mqtt_connected = false;
-	if (client)
+  if (client)  // connected to a remote broker
   {
     if (bSendDisconnect and client->connected())
     {
@@ -76,9 +76,15 @@ void MqttClient::close(bool bSendDisconnect)
   }
 }
 
+void MqttClient::connect(MqttBroker* parentBroker)
+{
+  close();
+  parent = parentBroker;
+}
+
 void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
 {
-	debug("cnx: closing");
+  debug("MqttClient::connect");
   keep_alive = ka;
   close();
   if (client) delete client;
@@ -184,7 +190,7 @@ MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
   return MqttNowhereToSend;
 }
 
-MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const
+MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const
 {
   MqttError retval = MqttOk;
 
@@ -244,7 +250,11 @@ void MqttClient::clientAlive(uint32_t more_seconds)
 {
   if (keep_alive)
   {
+#ifdef EPOXY_DUINO
+    alive=millis()+500000;
+#else
     alive=millis()+1000*(keep_alive+more_seconds);
+#endif
   }
   else
     alive=0;
@@ -389,16 +399,18 @@ MqttError MqttClient::sendTopic(const Topic& topic, MqttMessage::Type type, uint
   return msg.sendTo(this);
 }
 
-long MqttClient::counter=0;
-
-void MqttClient::processMessage(const MqttMessage* mesg)
+void MqttClient::processMessage(MqttMessage* mesg)
 {
-	counter++;
 #ifdef TINY_MQTT_DEBUG
 if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::Type::PingResp)
 {
+  #ifdef NOT_ESP_CORE
+    Serial << "---> INCOMING " << _HEX(mesg->type()) << " client(" << (dbg_ptr)client << ':' << clientId << ") mem=" << " ESP.getFreeHeap() "<< endl;
+  #else
     Serial << "---> INCOMING " << _HEX(mesg->type()) << " client(" << (dbg_ptr)client << ':' << clientId << ") mem=" << ESP.getFreeHeap() << endl;
+  #endif
   // mesg->hexdump("Incoming");
+  mesg->hexdump("Incoming");
 }
 #endif
   auto header = mesg->getVHeader();
@@ -406,7 +418,11 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
   uint16_t len;
   bool bclose=true;
 
-	switch(mesg->type() & 0XF0)
+#ifdef EPOXY_DUINO
+  counters[mesg->type()]++;
+#endif
+
+  switch(mesg->type())
   {
     case MqttMessage::Type::Connect:
       if (mqtt_connected)
@@ -436,11 +452,9 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
       if (mqtt_flags & FlagWill)  // Will topic
       {
         mesg->getString(payload, len);  // Will Topic
-				outstring("WillTopic", payload, len);
         payload += len;
 
         mesg->getString(payload, len);  // Will Message
-				outstring("WillMessage", payload, len);
         payload += len;
       }
       // FIXME forgetting credential is allowed (security hole)
@@ -457,7 +471,9 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
         payload += len;
       }
 
+      #ifdef TINY_MQTT_DEBUG
         Serial << "Connected client:" << clientId.c_str() << ", keep alive=" << keep_alive << '.' << endl;
+      #endif
       bclose = false;
       mqtt_connected=true;
       {
@@ -507,18 +523,25 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
         payload = header+2;
         
         debug("un/subscribe loop");
+        std::string qoss;
         while(payload < mesg->end())
         {
           mesg->getString(payload, len);  // Topic
           debug( "  topic (" << std::string(payload, len) << ')');
-					outstring("  un/subscribes", payload, len);
           // subscribe(Topic(payload, len));
           Topic topic(payload, len);
+
           payload += len;
-					if ((mesg->type() & 0XF0) == MqttMessage::Type::Subscribe)
+          if (mesg->type() == MqttMessage::Type::Subscribe)
           {
             uint8_t qos = *payload++;
-						if (qos != 0) debug("Unsupported QOS" << qos << endl);
+            if (qos != 0)
+            {
+              debug("Unsupported QOS" << qos << endl);
+              qoss.push_back(0x80);
+            }
+            else
+              qoss.push_back(qos);
             subscriptions.insert(topic);
           }
           else
@@ -530,7 +553,12 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
         }
         debug("end loop");
         bclose = false;
-				// TODO SUBACK
+
+        MqttMessage ack(mesg->type() == MqttMessage::Type::Subscribe ? MqttMessage::Type::SubAck : MqttMessage::Type::UnSuback);
+        ack.add(header[0]);
+        ack.add(header[1]);
+        ack.add(qoss.c_str(), qoss.size(), false);
+        ack.sendTo(this);
       }
       break;
 
@@ -540,9 +568,12 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
       break;
 
     case MqttMessage::Type::Publish:
+      #ifdef TINY_MQTT_DEBUG
+        Serial << "publish " << mqtt_connected << '/' << (long) client << endl;
+      #endif
       if (mqtt_connected or client == nullptr)
       {
-				uint8_t qos = mesg->type() & 0x6;
+        uint8_t qos = mesg->flags();
         payload = header;
         mesg->getString(payload, len);
         Topic published(payload, len);
@@ -554,8 +585,12 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
         // TODO reset DUP
         // TODO reset RETAIN
 
-				if (client==nullptr)	// internal MqttClient receives publish
+        if (parent==nullptr or client==nullptr)  // internal MqttClient receives publish
         {
+          #ifdef TINY_MQTT_DEBUG
+            Serial << (isSubscribedTo(published) ? "not" : "") << " subscribed.\n";
+            Serial << "has " << (callback ? "" : "no ") << " callback.\n";
+          #endif
           if (callback and isSubscribedTo(published))
           {
             callback(this, published, payload, len);  // TODO send the real payload
@@ -584,10 +619,12 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
   };
   if (bclose)
   {
+    #ifdef TINY_MQTT_DEBUG
       Serial << "*************** Error msg 0x" << _HEX(mesg->type());
       mesg->hexdump("-------ERROR ------");
       dump();
       Serial << endl;
+    #endif
     close();
   }
   else
@@ -610,6 +647,7 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
   msg.add(topic);
   msg.add(payload, pay_length, false);
   msg.complete();
+
   if (parent)
   {
     return parent->publish(this, topic, msg);
@@ -621,7 +659,7 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
 }
 
 // republish a received publish if it matches any in subscriptions
-MqttError MqttClient::publishIfSubscribed(const Topic& topic, const MqttMessage& msg)
+MqttError MqttClient::publishIfSubscribed(const Topic& topic, MqttMessage& msg)
 {
   MqttError retval=MqttOk;
 
@@ -633,6 +671,10 @@ MqttError MqttClient::publishIfSubscribed(const Topic& topic, const MqttMessage&
     else
     {
       processMessage(&msg);
+
+      #ifdef TINY_MQTT_DEBUG
+        Serial << "Should call the callback ?\n";
+      #endif
       // callback(this, topic, nullptr, 0);  // TODO Payload
     }
   }
@@ -661,29 +703,23 @@ void MqttMessage::incoming(char in_byte)
   switch(state)
   {
     case FixedHeader:
-			size=0;
+      size=MaxBufferLength;
       state = Length;
       break;
     case Length:
-		  if (size==0)
+
+      if (size==MaxBufferLength)
         size = in_byte & 0x7F;
-		  else if (size<128)
-		    size += static_cast<uint16_t>(in_byte & 0x7F)<<7;
       else
-		    state = Error;  // Really don't want to handle msg with length > 16k
+        size += static_cast<uint16_t>(in_byte & 0x7F)<<7;
+
       if (size > MaxBufferLength)
-			{
         state = Error;
-			}
       else if ((in_byte & 0x80) == 0)
       {
         vheader = buffer.length();
         if (size==0)
           state = Complete;
-				else if (size > 500)	// TODO magic
-				{
-					state = Error;
-				}
         else
         {
           buffer.reserve(size);
@@ -705,12 +741,14 @@ void MqttMessage::incoming(char in_byte)
       break;
     case Complete:
     default:
+      #ifdef TINY_MQTT_DEBUG
         Serial << "Spurious " << _HEX(in_byte) << endl;
         hexdump("spurious");
+      #endif
       reset();
       break;
   }
-	if (buffer.length() > MaxBufferLength)	// TODO magic 256 ?
+  if (buffer.length() > MaxBufferLength)
   {
     debug("Too long " << state);
     reset();
@@ -721,36 +759,42 @@ void MqttMessage::add(const char* p, size_t len, bool addLength)
 {
   if (addLength)
   {
-		buffer.reserve(buffer.length()+addLength+2);
+    buffer.reserve(buffer.length()+2);
     incoming(len>>8);
     incoming(len & 0xFF);
   }
   while(len--) incoming(*p++);
 }
 
-void MqttMessage::encodeLength(char* msb, int length) const
+void MqttMessage::encodeLength()
 {
-	do
+  if (state != Complete)
   {
-		uint8_t encoded(length & 0x7F);
-		length >>=7;
-		if (length) encoded |= 0x80;
-		*msb++ = encoded;
-	} while (length);
-};
-
-void MqttMessage::complete()
+    int length = buffer.size()-3;  // 3 = 1 byte for header + 2 bytes for pre-reserved length field.
+    if (length <= 0x7F)
     {
-		encodeLength(&buffer[1], buffer.size()-2);
-		state = Complete;
+      buffer.erase(1,1);
+      buffer[1] = length;
+      vheader = 2;
+    }
+    else
+    {
+      buffer[1] = 0x80 | (length & 0x7F);
+      buffer[2] = (length >> 7);
+      vheader = 3;
     }
       
-MqttError MqttMessage::sendTo(MqttClient* client) const
+    // We could check that buffer[2] < 128 (end of length encoding)
+    state = Complete;
+  }
+};
+
+MqttError MqttMessage::sendTo(MqttClient* client)
 {
   if (buffer.size())
   {
     debug("sending " << buffer.size() << " bytes");
-		encodeLength(&buffer[1], buffer.size()-2);
+    encodeLength();
     // hexdump("snd");
     client->write(&buffer[0], buffer.size());
   }
@@ -764,6 +808,8 @@ MqttError MqttMessage::sendTo(MqttClient* client) const
 
 void MqttMessage::hexdump(const char* prefix) const
 {
+  (void)prefix;
+#ifdef TINY_MQTT_DEBUG
   uint16_t addr=0;
   const int bytes_per_row = 8;
   const char* hex_to_str = " | ";
@@ -799,4 +845,5 @@ void MqttMessage::hexdump(const char* prefix) const
   }
 
   Serial << endl;
+#endif
 }

src/TinyMqtt.h

@@ -20,6 +20,14 @@
 #else
   #define dbg_ptr uint32_t
 #endif
+
+#ifdef WIO_TERMINAL
+  // Uncommon board handling
+  // If you have a problem with this line, just remove it.
+  // Note: https://github.com/hsaturn/TinyMqtt/issues/41
+  #include <rpcWiFi.h>
+#endif
+
 #include <vector>
 #include <set>
 #include <string>
@@ -29,7 +37,7 @@
 // #define TINY_MQTT_DEBUG
 
 #ifdef TINY_MQTT_DEBUG
-  #define debug(what) { Serial << __LINE__ << ' ' << what << endl; delay(100); }
+  #define debug(what) { Serial << (int)__LINE__ << ' ' << what << endl; delay(100); }
 #else
   #define debug(what) {}
 #endif
@@ -42,7 +50,7 @@
   using TcpServer = WiFiServer;
 #endif
 
-enum MqttError
+enum __attribute__((packed)) MqttError
 {
   MqttOk = 0,
   MqttNowhereToSend=1,
@@ -64,9 +72,9 @@ class Topic : public IndexedString
 class MqttClient;
 class MqttMessage
 {
-	const uint16_t MaxBufferLength = 4096;  //hard limit: 16k
+  const uint16_t MaxBufferLength = 4096;  //hard limit: 16k due to size decoding
   public:
-		enum Type
+    enum __attribute__((packed)) Type
     {
       Unknown     =    0,
       Connect     = 0x10,
@@ -81,7 +89,7 @@ class MqttMessage
       PingResp    = 0xD0,
       Disconnect  = 0xE0
     };
-		enum State
+    enum __attribute__((packed)) State
     {
       FixedHeader=0,
       Length=1,
@@ -101,8 +109,7 @@ class MqttMessage
     void add(const Topic& t) { add(t.str()); }
     const char* end() const { return &buffer[0]+buffer.size(); }
     const char* getVHeader() const { return &buffer[vheader]; }
-		uint16_t length() const { return buffer.size(); }
-		void complete();
+    void complete() { encodeLength(); }
 
     void reset();
 
@@ -112,24 +119,27 @@ class MqttMessage
 
     Type type() const
     {
-			return state == Complete ? static_cast<Type>(buffer[0]) : Unknown;
+      return state == Complete ? static_cast<Type>(buffer[0] & 0xF0) : Unknown;
     }
 
+    uint8_t flags() const { return static_cast<uint8_t>(buffer[0] & 0x0F); }
+
     void create(Type type)
     {
-			buffer=(char)type;
-			buffer+='\0';		// reserved for msg length
-			vheader=2;
+      buffer=(decltype(buffer)::value_type)type;
+      buffer+='\0';    // reserved for msg length byte 1/2
+      buffer+='\0';    // reserved for msg length byte 2/2 (fixed)
+      vheader=3;      // Should never change
       size=0;
       state=Create;
     }
-		MqttError sendTo(MqttClient*) const;
+    MqttError sendTo(MqttClient*);
     void hexdump(const char* prefix=nullptr) const;
 
   private:
-		void encodeLength(char* msb, int length) const;
+    void encodeLength();
 
-		mutable std::string buffer;	// mutable -> sendTo()
+    std::string buffer;
     uint8_t vheader;
     uint16_t size;  // bytes left to receive
     State state;
@@ -139,7 +149,7 @@ class MqttBroker;
 class MqttClient
 {
   using CallBack = void (*)(const MqttClient* source, const Topic& topic, const char* payload, size_t payload_length);
-	enum Flags
+  enum __attribute__((packed)) Flags
   {
     FlagUserName = 128,
     FlagPassword = 64,
@@ -160,6 +170,8 @@ class MqttClient
     void connect(MqttBroker* parent);
     void connect(std::string broker, uint16_t port, uint16_t keep_alive = 10);
 
+    // TODO it seems that connected returns true in tcp mode even if
+    // no negociation occured (only if tcp link is established)
     bool connected() { return
       (parent!=nullptr and client==nullptr) or
       (client and client->connected()); }
@@ -172,7 +184,14 @@ class MqttClient
     /** Should be called in main loop() */
     void loop();
     void close(bool bSendDisconnect=true);
-		void setCallback(CallBack fun) {callback=fun; };
+    void setCallback(CallBack fun)
+    {
+      callback=fun;
+      #ifdef TINY_MQTT_DEBUG
+        Serial << "Callback set to " << (long)fun << endl;
+        if (callback) callback(this, "test/topic", "value", 5);
+      #endif
+    };
 
     // Publish from client to the world
     MqttError publish(const Topic&, const char* payload, size_t pay_length);
@@ -191,6 +210,8 @@ class MqttClient
 
     void dump(std::string indent="")
     {
+      (void)indent;
+      #ifdef TINY_MQTT_DEBUG
         uint32_t ms=millis();
         Serial << indent << "+-- " << '\'' << clientId.c_str() << "' " << (connected() ? " ON " : " OFF");
         Serial << ", alive=" << alive << '/' << ms << ", ka=" << keep_alive << ' ';
@@ -200,6 +221,7 @@ class MqttClient
           bool c = false;
           Serial << " [";
           for(auto s: subscriptions)
+            (void)indent;
           {
             if (c) Serial << ", ";
             Serial << s.str().c_str();
@@ -208,12 +230,16 @@ class MqttClient
           Serial << ']';
         }
         Serial << endl;
+      #endif
     }
 
-		/** Count the number of messages that have been sent **/
-		static long counter;
+#ifdef EPOXY_DUINO
+    static std::map<MqttMessage::Type, int> counters;  // Number of processed messages
+#endif
 
   private:
+
+    // event when tcp/ip link established (real or fake)
     static void onConnect(void * client_ptr, TcpClient*);
 #ifdef TCP_ASYNC
     static void onData(void* client_ptr, TcpClient*, void* data, size_t len);
@@ -224,10 +250,10 @@ class MqttClient
     friend class MqttBroker;
     MqttClient(MqttBroker* parent, TcpClient* client);
     // republish a received publish if topic matches any in subscriptions
-		MqttError publishIfSubscribed(const Topic& topic, const MqttMessage& msg);
+    MqttError publishIfSubscribed(const Topic& topic, MqttMessage& msg);
 
     void clientAlive(uint32_t more_seconds);
-		void processMessage(const MqttMessage* message);
+    void processMessage(MqttMessage* message);
 
     bool mqtt_connected = false;
     char mqtt_flags;
@@ -240,7 +266,7 @@ class MqttClient
     // (this is the case when MqttBroker isn't used except here)
     MqttBroker* parent=nullptr;    // connection to local broker
 
-		TcpClient* client=nullptr;		// connection to mqtt client or to remote broker
+    TcpClient* client=nullptr;    // connection to remote broker
     std::set<Topic>  subscriptions;
     std::string clientId;
     CallBack callback = nullptr;
@@ -248,7 +274,7 @@ class MqttClient
 
 class MqttBroker
 {
-	enum State
+  enum __attribute__((packed)) State
   {
     Disconnected,  // Also the initial state
     Connecting,    // connect and sends a fake publish to avoid circular cnx
@@ -284,7 +310,7 @@ class MqttBroker
     { return compareString(auth_password, password, len); }
 
 
-		MqttError publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const;
+    MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const;
 
     MqttError subscribe(const Topic& topic, uint8_t qos);
 

tests/howto

@@ -0,0 +1,7 @@
+cd TinyMqtt/tests/../..
+git clone https://github.com/hsaturn/EspMock.git
+git clone https://github.com/bxparks/AUnit.git
+git clone https://github.com/bxparks/EpoxyDuino.git
+cd TinyMqtt/tests
+make
+make runtests

tests/length-tests.todo/Makefile

@@ -1,6 +1,8 @@
 # See https://github.com/bxparks/EpoxyDuino for documentation about this
 # Makefile to compile and run Arduino programs natively on Linux or MacOS.
 
+EXTRA_CXXFLAGS=-g3 -O0
+
 APP_NAME := length-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi  ESPAsyncTCP
 ARDUINO_LIB_DIRS := ../../../EspMock/libraries

tests/local-tests/Makefile

@@ -1,6 +1,11 @@
 # See https://github.com/bxparks/EpoxyDuino for documentation about this
 # Makefile to compile and run Arduino programs natively on Linux or MacOS.
 
+EXTRA_CXXFLAGS=-g3 -O0
+
+# Remove flto flag from EpoxyDuino (too many <optimized out>)
+CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
+
 APP_NAME := local-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi  ESPAsyncTCP
 ARDUINO_LIB_DIRS := ../../../EspMock/libraries

tests/local-tests/local-tests.ino

@@ -31,12 +31,10 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
 
 test(local_client_should_unregister_when_destroyed)
 {
-return;
   assertEqual(broker.clientsCount(), (size_t)0);
   {
-		MqttClient client;
     assertEqual(broker.clientsCount(), (size_t)0);  // Ensure client is not yet connected
-		client.connect("127.0.0.1", 1883);
+    MqttClient client(&broker);
     assertEqual(broker.clientsCount(), (size_t)1);  // Ensure client is now connected
   }
   assertEqual(broker.clientsCount(), (size_t)0);
@@ -68,8 +66,8 @@ test(local_publish_should_be_dispatched)
   publisher.publish("a/c");
 
   assertEqual(published.size(), (size_t)1);  // 1 client has received something
-	assertTrue(published[""]["a/b"] == 1);
-	assertTrue(published[""]["a/c"] == 2);
+  assertEqual(published[""]["a/b"], 1);
+  assertEqual(published[""]["a/c"], 2);
 }
 
 test(local_publish_should_be_dispatched_to_local_clients)
@@ -91,10 +89,10 @@ test(local_publish_should_be_dispatched_to_local_clients)
   publisher.publish("a/c");
 
   assertEqual(published.size(), (size_t)2);  // 2 clients have received something
-	assertTrue(published["A"]["a/b"] == 1);
-	assertTrue(published["A"]["a/c"] == 1);
-	assertTrue(published["B"]["a/b"] == 1);
-	assertTrue(published["B"]["a/c"] == 0);
+  assertEqual(published["A"]["a/b"], 1);
+  assertEqual(published["A"]["a/c"], 1);
+  assertEqual(published["B"]["a/b"], 1);
+  assertEqual(published["B"]["a/c"], 0);
 }
 
 test(local_unsubscribe)
@@ -114,7 +112,7 @@ test(local_unsubscribe)
   publisher.publish("a/b");
   publisher.publish("a/b");
 
-	assertTrue(published[""]["a/b"] == 1);	// Only one publish has been received
+  assertEqual(published[""]["a/b"], 1);  // Only one publish has been received
 }
 
 test(local_nocallback_when_destroyed)
@@ -143,7 +141,7 @@ void setup() {
   Serial.begin(115200);
   while(!Serial);
 
-	Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================");
+  Serial.println("=============[ LOCAL TinyMqtt TESTS              ]========================");
 }
 
 void loop() {

tests/network-tests/Makefile

@@ -0,0 +1,13 @@
+# See https://github.com/bxparks/EpoxyDuino for documentation about this
+# Makefile to compile and run Arduino programs natively on Linux or MacOS.
+
+EXTRA_CXXFLAGS=-g3 -O0
+
+# Remove flto flag from EpoxyDuino (too many <optimized out>)
+CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
+
+APP_NAME := network-tests
+ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi  ESPAsyncTCP
+ARDUINO_LIB_DIRS := ../../../EspMock/libraries
+EPOXY_CORE := EPOXY_CORE_ESP8266
+include ../../../EpoxyDuino/EpoxyDuino.mk

tests/network-tests/network-tests.ino

@@ -0,0 +1,429 @@
+#include <Arduino.h>
+#include <AUnit.h>
+#include <TinyMqtt.h>
+#include <map>
+#include <iostream>
+#include <iomanip>
+#include <sstream>
+#include <string>
+
+/**
+  * TinyMqtt network unit tests.
+	*
+	* No wifi connection unit tests.
+  * Checks with a local broker. Clients must connect to the local broker
+	**/
+
+// if ascii_pos = 0, no ascii dump, else ascii dump starts after column ascii_pos
+std::string bufferToHexa(const uint8_t* buffer, size_t length, char sep = 0, size_t ascii_pos = 0)
+{
+  std::stringstream out;
+  std::string ascii;
+  std::string h("0123456789ABCDEF");
+  for(size_t i=0; i<length; i++)
+  {
+    uint8_t c = buffer[i];
+    out << h[ c >> 4] << h[ c & 0x0F ];
+    if (sep) out << sep;
+    if (ascii_pos)
+    {
+      if (c>=32)
+        ascii += c;
+      else
+        ascii +='.';
+    }
+  }
+  std::string ret(out.str());
+  if (ascii_pos)
+  {
+    while(ret.length() < ascii_pos)
+      ret += ' ';
+    ret +='[' + ascii + ']';
+  }
+  return ret;
+}
+
+void dumpMqttMessage(const uint8_t* buffer, size_t length)
+{
+  std::map<int, std::string> pkt =
+  { { MqttMessage::Unknown     , "Unknown     " },
+    { MqttMessage::Connect     , "Connect     " },
+    { MqttMessage::ConnAck     , "ConnAck     " },
+    { MqttMessage::Publish     , "Publish     " },
+    { MqttMessage::PubAck      , "PubAck      " },
+    { MqttMessage::Subscribe   , "Subscribe   " },
+    { MqttMessage::SubAck      , "SubAck      " },
+    { MqttMessage::UnSubscribe , "Unsubscribe " },
+    { MqttMessage::UnSuback    , "UnSubAck    " },
+    { MqttMessage::PingReq     , "PingReq     " },
+    { MqttMessage::PingResp    , "PingResp    " },
+    { MqttMessage::Disconnect  , "Disconnect  " } };
+
+  std::cout << "       |   data sent " << std::setw(3) << length << " : ";
+  auto it = pkt.find(buffer[0] & 0xF0);
+  if (it == pkt.end())
+    std::cout << pkt[MqttMessage::Unknown];
+  else
+    std::cout << it->second;
+
+  std::cout << bufferToHexa(buffer, length, ' ', 60) << std::endl;
+}
+
+String toString(const IPAddress& ip)
+{
+  return String(ip[0])+'.'+String(ip[1])+'.'+String(ip[2])+'.'+String(ip[3]);
+}
+
+MqttBroker broker(1883);
+
+std::map<std::string, std::map<Topic, int>>	published;		// map[client_id] => map[topic] = count
+
+char* lastPayload = nullptr;
+size_t lastLength;
+
+void start_servers(int n, bool early_accept = true)
+{
+    ESP8266WiFiClass::resetInstances();
+    ESP8266WiFiClass::earlyAccept = early_accept;
+    while(n)
+    {
+      ESP8266WiFiClass::selectInstance(n--);
+      WiFi.mode(WIFI_STA);
+      WiFi.begin("fake_ssid", "fake_pwd");
+    }
+}
+
+void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
+{
+	if (srce)
+		published[srce->id()][topic]++;
+	
+	if (lastPayload) free(lastPayload);
+  lastPayload = strdup(payload);
+	lastLength = length;
+}
+
+test(network_single_broker_begin)
+{
+  assertEqual(WiFi.status(), WL_CONNECTED);
+
+  MqttBroker broker(1883);
+  broker.begin();
+
+  // TODO Nothing is tested here !
+}
+
+test(suback)
+{
+  start_servers(2, true);
+  assertEqual(WiFi.status(), WL_CONNECTED);
+
+  MqttBroker broker(1883);
+  broker.begin();
+  IPAddress broker_ip = WiFi.localIP();
+
+  ESP8266WiFiClass::selectInstance(2);
+  MqttClient client;
+  client.connect(broker_ip.toString().c_str(), 1883);
+  broker.loop();
+
+  assertTrue(broker.clientsCount() == 1);
+  assertTrue(client.connected());
+
+  MqttClient::counters[MqttMessage::Type::SubAck] = 0;
+  client.subscribe("a/b");
+
+  // TODO how to avoid these loops ???
+  broker.loop();
+  client.loop();
+
+  assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
+}
+
+test(network_client_to_broker_connexion)
+{
+  start_servers(2, true);
+  assertEqual(WiFi.status(), WL_CONNECTED);
+
+  MqttBroker broker(1883);
+  broker.begin();
+  IPAddress broker_ip = WiFi.localIP();
+
+  ESP8266WiFiClass::selectInstance(2);
+  MqttClient client;
+  client.connect(broker_ip.toString().c_str(), 1883);
+  broker.loop();
+
+  assertTrue(broker.clientsCount() == 1);
+  assertTrue(client.connected());
+}
+
+test(network_one_client_one_broker_publish_and_subscribe_through_network)
+{
+  start_servers(2, true);
+  published.clear();
+  assertEqual(WiFi.status(), WL_CONNECTED);
+
+  MqttBroker broker(1883);
+  broker.begin();
+  IPAddress ip_broker = WiFi.localIP();
+
+  // We have a 2nd ESP in order to test through wifi (opposed to local)
+  ESP8266WiFiClass::selectInstance(2);
+  MqttClient client;
+  client.connect(ip_broker.toString().c_str(), 1883);
+  broker.loop();
+  assertTrue(client.connected());
+
+  client.setCallback(onPublish);
+  client.subscribe("a/b");
+  client.publish("a/b", "ab");
+
+  for (int i =0; i<2; i++)
+  {
+    client.loop();
+    broker.loop();
+  }
+  
+  assertEqual(published.size(), (size_t)1);
+  assertEqual((int)lastLength, (int)2); // sizeof(ab)
+}
+
+test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
+{
+  start_servers(2, true);
+  published.clear();
+  assertEqual(WiFi.status(), WL_CONNECTED);
+
+  MqttBroker broker(1883);
+  broker.begin();
+  IPAddress ip_broker = WiFi.localIP();
+
+  // We have a 2nd ESP in order to test through wifi (opposed to local)
+  ESP8266WiFiClass::selectInstance(2);
+  MqttClient client;
+  client.connect(ip_broker.toString().c_str(), 1883);
+  broker.loop();
+  assertTrue(client.connected());
+
+  std::string sent;
+
+  for(int i=0; i<200; i++)
+    sent += char('0'+i%10);
+
+  client.setCallback(onPublish);
+  client.subscribe("a/b");
+  client.publish("a/b", sent.c_str());
+
+  for (int i =0; i<2; i++)
+  {
+    client.loop();
+    broker.loop();
+  }
+
+  assertEqual(published.size(), (size_t)1);
+  assertEqual((unsigned int)lastLength, (unsigned int)sent.size());
+}
+
+test(network_client_should_unregister_when_destroyed)
+{
+	assertEqual(broker.clientsCount(), (size_t)0);
+	{
+		MqttClient client(&broker);
+		assertEqual(broker.clientsCount(), (size_t)1);
+	}
+	assertEqual(broker.clientsCount(), (size_t)0);
+}
+
+
+// THESE TESTS ARE IN LOCAL MODE
+// WE HAVE TO CONVERT THEM TO WIFI MODE (pass through virtual TCP link)
+
+test(network_connect)
+{
+	assertEqual(broker.clientsCount(), (size_t)0);
+
+	MqttClient client(&broker);
+	assertTrue(client.connected());
+	assertEqual(broker.clientsCount(), (size_t)1);
+}
+
+test(network_publish_should_be_dispatched)
+{
+	published.clear();
+	assertEqual(broker.clientsCount(), (size_t)0);
+
+	MqttClient subscriber(&broker);
+	subscriber.subscribe("a/b");
+	subscriber.subscribe("a/c");
+	subscriber.setCallback(onPublish);
+
+	MqttClient publisher(&broker);
+	publisher.publish("a/b");
+	publisher.publish("a/c");
+	publisher.publish("a/c");
+
+	assertEqual(published.size(), (size_t)1);	// 1 client has received something
+	assertEqual(published[""]["a/b"], 1);
+	assertEqual(published[""]["a/c"], 2);
+}
+
+test(network_publish_should_be_dispatched_to_clients)
+{
+	published.clear();
+	assertEqual(broker.clientsCount(), (size_t)0);
+
+	MqttClient subscriber_a(&broker, "A");
+	subscriber_a.setCallback(onPublish);
+	subscriber_a.subscribe("a/b");
+	subscriber_a.subscribe("a/c");
+
+	MqttClient subscriber_b(&broker, "B");
+	subscriber_b.setCallback(onPublish);
+	subscriber_b.subscribe("a/b");
+
+	MqttClient publisher(&broker);
+	publisher.publish("a/b");		// A and B should receive this
+	publisher.publish("a/c");		// A should receive this 
+
+	assertEqual(published.size(), (size_t)2);	// 2 clients have received something
+	assertEqual(published["A"]["a/b"], 1);
+	assertEqual(published["A"]["a/c"], 1);
+	assertEqual(published["B"]["a/b"], 1);
+	assertEqual(published["B"]["a/c"], 0);
+}
+
+test(network_unsubscribe)
+{
+	published.clear();
+	assertEqual(broker.clientsCount(), (size_t)0);
+
+	MqttClient subscriber(&broker);
+	subscriber.setCallback(onPublish);
+	subscriber.subscribe("a/b");
+
+	MqttClient publisher(&broker);
+	publisher.publish("a/b");		// This publish is received
+
+	subscriber.unsubscribe("a/b");
+
+	publisher.publish("a/b");		// Those one, no (unsubscribed)
+	publisher.publish("a/b");
+
+	assertEqual(published[""]["a/b"], 1);	// Only one publish has been received
+}
+
+test(network_nocallback_when_destroyed)
+{
+	published.clear();
+	assertEqual(broker.clientsCount(), (size_t)0);
+
+	MqttClient publisher(&broker);
+
+	{
+		MqttClient subscriber(&broker);
+		subscriber.setCallback(onPublish);
+		subscriber.subscribe("a/b");
+		publisher.publish("a/b");
+	}
+
+	publisher.publish("a/b");
+
+	assertEqual(published.size(), (size_t)1);	// Only one publish has been received
+}
+
+test(network_small_payload)
+{
+	published.clear();
+
+	const char* payload="abcd";
+
+	MqttClient subscriber(&broker);
+	subscriber.setCallback(onPublish);
+	subscriber.subscribe("a/b");
+
+	MqttClient publisher(&broker);
+	publisher.publish("a/b", payload, strlen(payload));		// This publish is received
+
+  // coming from MqttClient::publish(...)
+  assertEqual(payload, lastPayload);
+	assertEqual(lastLength, (size_t)4);
+}
+
+test(network_hudge_payload)
+{
+  const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
+
+  MqttClient subscriber(&broker);
+  subscriber.setCallback(onPublish);
+  subscriber.subscribe("a/b");          // Note -> this does not send any byte .... (nowhere to send)
+
+	MqttClient publisher(&broker);
+	publisher.publish("a/b", payload);		// This publish is received
+
+  // onPublish should have filled lastPayload and lastLength
+  assertEqual(payload, lastPayload);
+	assertEqual(lastLength, strlen(payload));
+	assertEqual(strcmp(payload, lastPayload), 0);
+}
+
+test(connack)
+{
+  const bool view = false;
+
+  NetworkObserver check(
+    [this](const WiFiClient*, const uint8_t* buffer, size_t length)
+    {
+      if (view) dumpMqttMessage(buffer, length);
+      if (buffer[0] == MqttMessage::ConnAck)
+      {
+        std::string hex = bufferToHexa(buffer, length);
+        assertStringCaseEqual(hex.c_str(), "20020000");
+      }
+    }
+  );
+
+  start_servers(2, true);
+  assertEqual(WiFi.status(), WL_CONNECTED);
+
+  MqttBroker broker(1883);
+  broker.begin();
+  IPAddress broker_ip = WiFi.localIP();
+
+  ESP8266WiFiClass::selectInstance(2);
+  MqttClient client;
+  client.connect(broker_ip.toString().c_str(), 1883);
+  broker.loop();
+
+  assertTrue(broker.clientsCount() == 1);
+  assertTrue(client.connected());
+
+  MqttClient::counters[MqttMessage::Type::SubAck] = 0;
+  client.subscribe("a/b");
+
+  // TODO how to avoid these loops ???
+  broker.loop();
+  client.loop();
+
+  assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
+}
+
+//----------------------------------------------------------------------------
+// setup() and loop()
+void setup() {
+	/* delay(1000);
+	Serial.begin(115200);
+	while(!Serial);
+	*/
+
+	Serial.println("=============[ FAKE NETWORK TinyMqtt TESTS       ]========================");
+
+	WiFi.mode(WIFI_STA);
+	WiFi.begin("network", "password");
+}
+
+void loop() {
+	aunit::TestRunner::run();
+
+	if (Serial.available()) ESP.reset();
+}

tests/nowifi-tests/Makefile

@@ -1,6 +1,11 @@
 # See https://github.com/bxparks/EpoxyDuino for documentation about this
 # Makefile to compile and run Arduino programs natively on Linux or MacOS.
 
+EXTRA_CXXFLAGS=-g3 -O0
+
+# Remove flto flag from EpoxyDuino (too many <optimized out>)
+CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
+
 APP_NAME := nowifi-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi  ESPAsyncTCP
 ARDUINO_LIB_DIRS := ../../../EspMock/libraries

tests/nowifi-tests/nowifi-tests.ino

@@ -132,7 +132,7 @@ test(nowifi_nocallback_when_destroyed)
 	assertEqual(published.size(), (size_t)1);	// Only one publish has been received
 }
 
-test(nowifi_payload_nullptr)
+test(nowifi_small_payload)
 {
 	published.clear();
 
@@ -150,6 +150,22 @@ test(nowifi_payload_nullptr)
 	assertEqual(lastLength, (size_t)4);
 }
 
+test(nowifi_hudge_payload)
+{
+  const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
+
+  MqttClient subscriber(&broker);
+  subscriber.setCallback(onPublish);
+  subscriber.subscribe("a/b");
+
+	MqttClient publisher(&broker);
+	publisher.publish("a/b", payload);		// This publish is received
+
+  // onPublish should have filled lastPayload and lastLength
+  assertEqual(payload, lastPayload);
+	assertEqual(lastLength, strlen(payload));
+}
+
 //----------------------------------------------------------------------------
 // setup() and loop()
 void setup() {

tests/string-indexer-tests/Makefile

@@ -1,6 +1,8 @@
 # See https://github.com/bxparks/EpoxyDuino for documentation about this
 # Makefile to compile and run Arduino programs natively on Linux or MacOS.
 
+EXTRA_CXXFLAGS=-g3 -O0
+
 APP_NAME := string-indexer-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi  ESPAsync
 ARDUINO_LIB_DIRS := ../../../EspMock/libraries

tests/string-indexer-tests/string-indexer-tests.ino

@@ -62,6 +62,14 @@ test(indexer_same_strings_should_equal)
 	assertTrue(one == two);
 }
 
+test(indexer_compare_strings_with_same_beginning)
+{
+  IndexedString two("one_two");
+  IndexedString one("one");
+
+  assertNotEqual(one.getIndex(), two.getIndex());
+}
+
 test(indexer_indexed_operator_eq)
 {
 	IndexedString one("one");