Merge pull request #101 from 1technophile/patch-1

Fix PORT assignement

README.md

@@ -24,6 +24,8 @@ TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32
 
 ## Features
 
+- Supports retained messages (not activated by default)
+- Async Wifi compatible (me-no-dev/ESPAsyncTCP@^1.2.2)
 - 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)
@@ -63,6 +65,13 @@ TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32
 - tinymqtt-test : This is a complex sketch with a terminal console
   that allows to add clients publish, connect etc with interpreted commands.
 
+## Retained messages
+
+Qos 1 is not supported, but retained messages are. So a new subscription is able to send old messages.
+This feature is disabled by default.
+The default retain parameter of MqttBroker::MqttBroker takes an optional (0 by default) number of retained messages.
+MqttBroker::retain(n) will also make the broker store n messages at max.
+
 ## Standalone mode (zeroconf)
 -> The zeroconf mode is not yet implemented
 zeroconf clients to connect to broker on local network.

bump_version.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+current_version=$(git describe --tags --abbrev=0)
+
+function error
+{
+	echo
+	echo "ERROR *** $1"
+}
+if [ "$1" == "-d" ]; then
+  do=0
+  shift
+else
+  do=1
+fi
+if [ "$1" == "" ]; then
+	echo
+	echo "Syntax: $0 [-d] {new_version} [commit message]"
+	echo
+	echo "  -d : dry run, generate json and update properties but do not run git commands"
+	echo ""
+	echo "  Current version: $current_version"
+	echo
+else
+	tm=$(git status --porcelain -- src/TinyMqtt.h | wc -l)
+	echo "Current version: ($current_version)"
+	echo "New version    : ($1)"
+	echo "Take info from : library.properties"
+	if [ "$tm" == "1" ]; then
+		error "You cannot bump version if TinyMqtt.h is modified"
+		exit
+	fi
+	echo -n "Do you want to proceed ? "
+	read a
+	if [ "$a" == "y" ]; then
+		echo "Doing this..."
+		grep $current_version library.properties
+		if [ "$?" == "0" ]; then
+			sed -i "s/$current_version/$1/" library.properties
+			sed -i "s/#define TINY_MQTT_REVISION/#define TINY_MQTT_REVISION \"$1\"/" src/TinyMqtt.h
+
+      cp library.json.skeleton library.json
+      while ifs= read -r line; do
+        name=$(echo "$line" | sed "s/=.*//g")
+        value=$(echo "$line" | cut -d= -f 2 | sed 's/"//g')
+        echo "  Replacing $name in json"
+        if [ "$name" == "depends" ]; then
+          depends=$(echo "$value" | sed "s/,/ /g")
+          echo "  Depends=$depends"
+        fi
+        sed -i "s@#$name@$value@g" library.json
+      done < library.properties
+      deps=""
+      for depend in $depends; do
+        if [ "$deps" != "" ]; then
+          deps="$deps, "
+        fi
+        deps="$deps'$depend' : '*'"
+      done
+      sed -i "s@#dependencies@$deps@g" library.json
+      sed -i "s/'/\"/g" library.json
+      if [ "$do" == "1" ]; then
+        echo "Pushing all"
+        git add library.properties
+        git add library.json
+        git commit -m "Release $1 $2"
+        git tag $1
+        git push
+        git push --tags
+      fi
+		else
+			error "Current version does not match library.property version, aborting"
+		fi
+	fi
+fi

examples/W5500/client-with-W5500-ESP8266/client-with-W5500-ESP8266.ino

@@ -0,0 +1,111 @@
+#include <SPI.h>
+#include <Ethernet.h>
+                        
+#include "TinyMqtt.h"   // https://github.com/hsaturn/TinyMqtt
+
+#define WIZRST D3   //Specify pin to use for reseting W5500
+#define WIZCS  D1   //Specify the pin for SPI CS
+
+#define PORT 1883
+MqttBroker broker(PORT);
+unsigned long Time;
+unsigned long freeRam;
+
+/** Basic Mqtt Broker
+  *
+  *  +-----------------------------+
+  *  | ESP                         |
+  *  |       +--------+            |
+  *  |       | broker |            | 1883 <--- External client/s
+  *  |       +--------+            |
+  *  |                             |
+  *  +-----------------------------+
+  *
+  *  Your ESP will become a MqttBroker.
+  *  You can test it with any client such as mqtt-spy for example
+  *
+  */
+
+#if defined(USE_ETHERNET)
+
+byte mac[] = { 0x00, 0xAA, 0xBB, 0xE0, 0x01, 0x25 }; //MAC Address
+//IPAddress ip = (192,168,0,88); //Fixed IP Address
+
+#else
+
+const char* ssid = "xxxxxxx";
+const char* password = "xxxxxxxx";
+
+#endif
+
+
+void WizReset() {
+   Serial.print("Resetting Wiz W5500 Ethernet Board...  ");
+   pinMode(WIZRST, OUTPUT);
+   digitalWrite(WIZRST, HIGH);
+   delay(250);
+   digitalWrite(WIZRST, LOW);
+   delay(50);
+   digitalWrite(WIZRST, HIGH);
+   delay(350);
+   Serial.println("Done.");
+}
+
+void setup()
+{
+  Serial.begin(115200);
+  
+#if defined(USE_ETHERNET)
+
+  Ethernet.init(WIZCS);  // SPI CS Pin
+  SPI.begin();
+  WizReset();
+  Console << TinyConsole::green << "Starting Ethernet...." << endl;
+  Ethernet.begin(mac); //Connect using DHCP
+  //Ethernet.begin(mac,ip); //Connect using Fixed IP
+  if (Ethernet.hardwareStatus() == EthernetNoHardware) {
+    Console << TinyConsole::red << "Ethernet shield was not found.  Sorry, can't run without hardware. :(" << endl;
+  } else 
+  if (Ethernet.linkStatus() == LinkOFF) {
+    Console << TinyConsole::red << "Ethernet cable is not connected." << endl;
+  }
+  Console << TinyConsole::green << "Local Ethernet IP address: " << Ethernet.localIP() << endl;
+  broker.begin();
+  Console << "Broker ready (eth) : " << Ethernet.localIP() << " on port " << PORT << endl;
+
+#else
+
+  if (strlen(ssid)==0)
+    Console << TinyConsole::red << "****** PLEASE MODIFY ssid/password *************" << endl;
+  WiFi.disconnect();                 //Remove previous SSID & Password
+  WiFi.begin(ssid, password);        // Connect to the network
+  Console << TinyConsole::white << "WiFi Connecting to " << ssid << " ...";
+  int i = 0;
+  while (WiFi.status() != WL_CONNECTED) { // Wait for the Wi-Fi to connect
+    delay(1000);
+    Console << TinyConsole::white << ".";
+    i++;
+    if (i > 20) break;
+  }
+  Console << endl << endl;
+  Console << TinyConsole::green << "Connected to " << ssid << " IP address: " << WiFi.localIP() << endl;
+  broker.begin();
+  Console << "Broker ready (wifi) : " << WiFi.localIP() << " on port " << PORT << endl;  
+    
+#endif
+}
+
+void loop()
+{
+  broker.loop();
+  if(millis()-Time>10000) {
+     Time=millis();
+    if(ESP.getFreeHeap()!=freeRam)
+    {
+      freeRam=ESP.getFreeHeap();
+    Serial.print("RAM:");
+    Serial.println(freeRam);
+    }
+  }
+
+}

examples/W5500/client-with-W5500-RP2040/client-with-W5500-RP2040.ino

@@ -0,0 +1,117 @@
+#include <SPI.h>
+#include <Ethernet.h>
+                        
+#include "TinyMqtt.h"   // https://github.com/hsaturn/TinyMqtt
+
+#define WIZRST 20   //Specify pin to use for reseting W5500 = GPIO20
+#define WIZCS  17   //Specify the pin for SPI CS = GPIO17 = D5
+
+#define PORT 1883
+MqttBroker broker(PORT);
+unsigned long Time;
+unsigned long freeRam;
+
+/** Basic Mqtt Broker
+  *
+  *  +-----------------------------+
+  *  | ESP                         |
+  *  |       +--------+            |
+  *  |       | broker |            | 1883 <--- External client/s
+  *  |       +--------+            |
+  *  |                             |
+  *  +-----------------------------+
+  *
+  *  Your ESP will become a MqttBroker.
+  *  You can test it with any client such as mqtt-spy for example
+  *
+  */
+
+#if defined(USE_ETHERNET)
+
+byte mac[] = { 0x00, 0xAA, 0xBB, 0xE0, 0x01, 0x25 }; //MAC Address
+//IPAddress ip = (192,168,0,88); //Fixed IP Address
+
+#else
+
+const char* ssid = "xxxxxxx";
+const char* password = "xxxxxxxx";
+
+#endif
+
+
+void WizReset() {
+   Serial.print("Resetting Wiz W5500 Ethernet Board...  ");
+   pinMode(WIZRST, OUTPUT);
+   digitalWrite(WIZRST, HIGH);
+   delay(250);
+   digitalWrite(WIZRST, LOW);
+   delay(50);
+   digitalWrite(WIZRST, HIGH);
+   delay(350);
+   Serial.println("Done.");
+}
+
+void setup()
+{
+  Serial.begin(115200);
+  
+#if defined(USE_ETHERNET)
+
+  Ethernet.init(WIZCS);  
+  SPI.begin();
+  WizReset();
+  Console << TinyConsole::green << "Starting Ethernet...." << endl;
+  Ethernet.begin(mac); //Connect using DHCP
+  //Ethernet.begin(mac,ip); //Connect using Fixed IP
+  if (Ethernet.hardwareStatus() == EthernetNoHardware) {
+    Console << TinyConsole::red << "Ethernet shield was not found.  Sorry, can't run without hardware. :(" << endl;
+  } else 
+  if (Ethernet.linkStatus() == LinkOFF) {
+    Console << TinyConsole::red << "Ethernet cable is not connected." << endl;
+  }
+  Console << TinyConsole::green << "Local Ethernet IP address: " << Ethernet.localIP() << endl;
+  broker.begin();
+  Console << "Broker ready (eth) : " << Ethernet.localIP() << " on port " << PORT << endl;
+
+#else
+
+  if (strlen(ssid)==0)
+    Console << TinyConsole::red << "****** PLEASE MODIFY ssid/password *************" << endl;
+  WiFi.disconnect();                 //Remove previous SSID & Password
+  WiFi.begin(ssid, password);        // Connect to the network
+  Console << TinyConsole::white << "WiFi Connecting to " << ssid << " ...";
+  int i = 0;
+  while (WiFi.status() != WL_CONNECTED) { // Wait for the Wi-Fi to connect
+    delay(1000);
+    Console << TinyConsole::white << ".";
+    i++;
+    if (i > 20) break;
+  }
+  Console << endl << endl;
+  Console << TinyConsole::green << "Connected to " << ssid << " IP address: " << WiFi.localIP() << endl;
+  broker.begin();
+  Console << "Broker ready (wifi) : " << WiFi.localIP() << " on port " << PORT << endl;  
+    
+#endif
+}
+
+void loop()
+{
+  broker.loop();
+  if(millis()-Time>10000) {
+     Time=millis();
+    #ifdef ARDUINO_ARCH_RP2040
+      if(rp2040.getFreeHeap()!=freeRam) {
+        freeRam=rp2040.getFreeHeap();
+    #else
+      if(ESP.getFreeHeap()!=freeRam) {
+        freeRam=ESP.getFreeHeap();
+    #endif
+    
+      
+    Serial.print("RAM:");
+    Serial.println(freeRam);
+    }
+  }
+
+}

examples/W5500/client-with-W5500-RP2040/readme

@@ -0,0 +1,5 @@
+In TinyString.h the operator
+
+  TinyString& operator +=(int);
+
+may need to be added.

examples/simple-broker/simple-broker.ino

@@ -1,7 +1,9 @@
 #include "TinyMqtt.h"   // https://github.com/hsaturn/TinyMqtt
 
-#define PORT 1883
+const uint16_t PORT = 1883;
-MqttBroker broker(PORT);
+const uint8_t  RETAIN = 10;  // Max retained messages
+
+MqttBroker broker(PORT, RETAIN);
 
 /** Basic Mqtt Broker
   *
@@ -16,6 +18,8 @@ MqttBroker broker(PORT);
   *  Your ESP will become a MqttBroker.
 	*  You can test it with any client such as mqtt-spy for example
 	*
+	* Messages are retained *only* if retain > 0
+	*
   */
 
 const char* ssid = "";

examples/simple-client/simple-client.ino

@@ -1,7 +1,7 @@
 #include "TinyMqtt.h"    // https://github.com/hsaturn/TinyMqtt
 #include "TinyStreaming.h" // https://github.com/hsaturn/TinyConsole
 
-/** Simple Client (The simplest configuration)
+/** Simple Client (The simplest configuration, client only sends topics)
   *
   *
   *                   +--------+

examples/tinymqtt-test/tinymqtt-test.ino

@@ -15,8 +15,6 @@
 #include <string>
 #include <map>
 
-using string = TinyString;
-
 bool echo_on = true;
 auto green = TinyConsole::green;
 auto red = TinyConsole::red;
@@ -28,8 +26,11 @@ auto save_cursor = TinyConsole::save_cursor;
 auto restore_cursor = TinyConsole::restore_cursor;
 auto erase_to_end = TinyConsole::erase_to_end;
 
-const char* ssid = "";
+const char *ssid = "Freebox-786A2F";
-const char* password = "";
+const char *password = "usurpavi8dalum64lumine?";
+
+void onCommand(const string &command);
+void eval(string &cmd);
 
 struct free_broker
 {
@@ -43,8 +44,7 @@ struct free_broker
 const std::map<string, free_broker> list =
     {
         {"mqtthq", {"public.mqtthq.com", 8083, "publish/subscribe"}},
-  { "hivemq", { "broker.hivemq.com", 1883, "" }}
+        {"hivemq", {"broker.hivemq.com", 1883, ""}}};
-};
 
 /** Very complex example
  * Console allowing to make any kind of test,
@@ -88,7 +88,8 @@ void setup()
   delay(500);
 
   Console.cls();
-  Console << endl << endl;
+  Console << endl
+          << endl;
   Console << yellow
           << "***************************************************************" << endl;
   Console << "*  Welcome to the TinyMqtt console" << endl;
@@ -99,7 +100,8 @@ void setup()
   if (strlen(ssid) == 0)
     Console << red << "*  ERROR: You must modify ssid/password in order" << endl
             << "          to be able to connect to your Wifi network." << endl;
-  Console << endl << white;
+  Console << endl
+          << white;
 
   Console << "Connecting to '" << ssid << "' ";
 
@@ -109,9 +111,13 @@ void setup()
   WiFi.begin(ssid, password);
 
   while (WiFi.status() != WL_CONNECTED)
-  { Console << '-'; delay(500); }
+  {
+    Console << '-';
+    delay(500);
+  }
 
-  Console << endl << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
+  Console << endl
+          << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
 
   const char *name = "tinytest";
   Console << "Starting MDNS, name= " << name;
@@ -120,12 +126,14 @@ void setup()
   else
     Console << " ok." << endl;
 
-
   MqttBroker *broker = new MqttBroker(1883);
   broker->begin();
   brokers["broker"] = broker;
 
-  if (Console.isTerm()) onCommand("every 333 view");
+  if (Console.isTerm())
+    onCommand("every 333 view");
+
+  Console.prompt();
 }
 
 string getword(string &str, const char *if_empty = nullptr, char sep = ' ');
@@ -137,8 +145,10 @@ int getint(string& str, const int if_empty=0)
   if (sword[0] and isdigit(sword[0]))
   {
     int ret = atoi(sword.c_str());
-    while(isdigit(sword[0]) or sword[0]==' ') sword.erase(0,1);
+    while (isdigit(sword[0]) or sword[0] == ' ')
-    if (sword.length()) str = sword+' '+str;
+      sword.erase(0, 1);
+    if (sword.length())
+      str = sword + ' ' + str;
     return ret;
   }
   str = str2;
@@ -148,7 +158,8 @@ int getint(string& str, const int if_empty=0)
 string getword(string &str, const char *if_empty /*=nullptr*/, char sep /*=' '*/)
 {
   char quote = (str[0] == '"' or str[0] == '\'' ? str[0] : 0);
-  if (quote) str.erase(0,1);
+  if (quote)
+    str.erase(0, 1);
   string sword;
   while (str.length() and (str[0] != sep or quote))
   {
@@ -160,8 +171,10 @@ string getword(string& str, const char* if_empty/*=nullptr*/, char sep/*=' '*/)
     sword += str[0];
     str.erase(0, 1);
   }
-  while(str[0]==sep) str.erase(0,1);
+  while (str[0] == sep)
-  if (if_empty and sword.length()==0) return if_empty;
+    str.erase(0, 1);
+  if (if_empty and sword.length() == 0)
+    return if_empty;
   if (quote == false and sword.length() >= 4 and sword.substr(0, 3) == "rnd")
   {
     sword.erase(0, 3);
@@ -174,7 +187,8 @@ string getword(string& str, const char* if_empty/*=nullptr*/, char sep/*=' '*/)
       {
         sword.erase(0, 1);
         to = getint(sword);
-        if (sword[0]!=')') Console << "Missing ')'" << endl;
+        if (sword[0] != ')')
+          Console << "Missing ')'" << endl;
       }
       else
       {
@@ -188,15 +202,18 @@ string getword(string& str, const char* if_empty/*=nullptr*/, char sep/*=' '*/)
       Console << "Missing '('" << endl;
     }
   }
-  while(str[0]==' ') str.erase(0,1);
+  while (str[0] == ' ')
+    str.erase(0, 1);
   return sword;
 }
 
 bool isaddr(string s)
 {
-  if (s.length()==0 or s.length()>3) return false;
+  if (s.length() == 0 or s.length() > 3)
+    return false;
   for (char c : s)
-    if (c<'0' or c>'9') return false;
+    if (c < '0' or c > '9')
+      return false;
   return true;
 }
 
@@ -225,7 +242,8 @@ string getip(string& str, const char* if_empty=nullptr, char sep=' ')
   }
   for (string s : build)
   {
-    if (addr.length()) addr += '.';
+    if (addr.length())
+      addr += '.';
     addr += s;
   }
   Console << "connect address: " << addr << endl;
@@ -238,20 +256,22 @@ std::set<string> commands = {
     "broker", "blink", "client", "connect",
     "create", "delete", "debug", "help", "interval",
     "list", "ls", "ip", "off", "on", "set",
-  "publish", "reset", "subscribe", "unsubscribe", "view", "echo", "every"
+    "publish", "reset", "subscribe", "unsubscribe", "view", "echo", "every"};
-};
 
 void convertToCommand(string &search)
 {
-  while(search[0]==' ') search.erase(0,1);
+  while (search[0] == ' ')
-  if (search.length()==0) return;
+    search.erase(0, 1);
+  if (search.length() == 0)
+    return;
   string matches;
   int count = 0;
   for (string cmd : commands)
   {
     if (cmd.substr(0, search.length()) == search)
     {
-      if (count) matches +=", ";
+      if (count)
+        matches += ", ";
       count++;
       matches += cmd;
     }
@@ -295,7 +315,6 @@ void replaceVars(string& cmd)
   }
   cmd.erase(0, cmd.find_first_not_of(' '));
   cmd.erase(cmd.find_last_not_of(' ') + 1);
-
 }
 
 bool compare(string s, const char *cmd)
@@ -303,8 +322,10 @@ bool compare(string s, const char* cmd)
   uint8_t p = 0;
   while (s[p++] == *cmd++)
   {
-    if (*cmd==0 or s[p]==0) return true;
+    if (*cmd == 0 or s[p] == 0)
-    if (s[p]==' ') return true;
+      return true;
+    if (s[p] == ' ')
+      return true;
   }
   return false;
 }
@@ -347,10 +368,10 @@ void onCommand(const string& command)
 {
   Console << endl;
   string cmd = command;
-  if (cmd.substr(0,3)!="set") replaceVars(cmd);
+  if (cmd.substr(0, 3) != "set")
+    replaceVars(cmd);
   eval(cmd);
   Console << endl;
-  Console.prompt();
 }
 
 void clientConnect(MqttClient *client, string &cmd)
@@ -406,16 +427,10 @@ void eval(string& cmd)
     }
 
     s = getword(cmd);
-    if (s.length()) convertToCommand(s);
+    if (s.length())
+      convertToCommand(s);
     if (s.length() == 0)
-    {}
-    else if (compare(s, "debug"))
     {
-#if TINY_MQTT_DEBUG
-      TinyMqtt::debug = getint(cmd);
-#else
-      Console << red << "TinyMqtt not compiled in debug" << endl;
-#endif
     }
     else if (compare(s, "list"))
     {
@@ -425,6 +440,10 @@ void eval(string& cmd)
         Console << "  " << fb.first << " : " << fb.second.url << ":" << fb.second.port << endl;
       }
     }
+    else if (compare(s, "free"))
+    {
+      Console << "Free memory: " << ESP.getFreeHeap() << endl;
+    }
     else if (compare(s, "delete"))
     {
       if (client == nullptr && broker == nullptr)
@@ -445,7 +464,8 @@ void eval(string& cmd)
       {
         for (auto it : clients)
         {
-          if (it.second != client) continue;
+          if (it.second != client)
+            continue;
           Console << "deleted" << endl;
           delete (it.second);
           clients.erase(it.first);
@@ -457,7 +477,8 @@ void eval(string& cmd)
       {
         for (auto it : brokers)
         {
-          if (broker != it.second) continue;
+          if (broker != it.second)
+            continue;
           Console << "deleted" << endl;
           delete (it.second);
           brokers.erase(it.first);
@@ -472,7 +493,22 @@ void eval(string& cmd)
     {
       if (compare(s, "connect"))
       {
-        Console << "NYI" << endl;
+        string remote = getword(cmd);
+        int port = getint(cmd);
+        if (port == 0) port=1883;
+        broker->connect(remote, port);
+        if (broker->connected())
+          Console << "Broker connected";
+        else
+          Console << red << "Unable to connect";
+
+        Console << " to " << remote << ':' << port << white << endl;
+      }
+      else if (compare(s, "retain"))
+      {
+        if (cmd.size())
+          broker->retain(getint(cmd));
+        Console << "retain=" << broker->retain() << ", retained msg=" << broker->retainCount() << endl;
       }
       else if (compare(s, "view"))
       {
@@ -490,6 +526,10 @@ void eval(string& cmd)
       {
         clientConnect(client, cmd);
       }
+      else if (compare(s, "rpublish"))
+      {
+        retval = client->publish(getword(cmd), getword(cmd), true);
+      }
       else if (compare(s, "publish"))
       {
         retval = client->publish(getword(cmd), getword(cmd));
@@ -677,7 +717,8 @@ void eval(string& cmd)
         if (s == "" or brokers.find(s) != brokers.end() or list.find(s) != list.end())
         {
           MqttBroker *broker = nullptr;
-          if (s.length()) broker = brokers[s];
+          if (s.length())
+            broker = brokers[s];
           MqttClient *client = new MqttClient(broker, id);
           clients[id] = client;
           client->setCallback(onPublish);
@@ -734,7 +775,8 @@ void eval(string& cmd)
         Console << save_cursor << magenta;
         Console.gotoxy(1, 1);
       }
-      Console << "--< " << '/' << clients.size() << " client/s. >--" << erase_to_end << endl;
+      Console << "--< " << '/' << clients.size() << " client/s. >--" << erase_to_end;
+      Console << "    (FreeMem: " << ESP.getFreeHeap() << ')' << endl;
       for (auto it : clients)
       {
         it.second->dump("  ");
@@ -760,19 +802,22 @@ void eval(string& cmd)
     {
       Console << "syntax:" << endl;
       Console << "  MqttBroker:" << endl;
-      Console << "    broker {broker_name} {port} : create a new broker" << endl;
+      Console << "    broker {name} {port} : create a new broker" << endl;
-      Console << "      broker_name can be one of 'list'" << endl;
+      Console << "      name can be one of 'list'" << endl;
-      Console << "      broker_name.delete : delete a broker (buggy)" << endl;
+      Console << "      name.delete     : delete a broker (buggy)" << endl;
-      Console << "      broker_name.view   : dump a broker" << endl;
+      Console << "      name.retain [#] : show/set retain value" << endl;
+      Console << "      name.view       : dump a broker" << endl;
       Console << endl;
       Console << "  MqttClient:" << endl;
       Console << "    client {name} {broker} : create a client then" << endl;
       Console << "      name.connect  [ip] [port] [alive]" << endl;
       Console << "      name.[un]subscribe topic" << endl;
       Console << "      name.publish topic [payload]" << endl;
+      Console << "      name.rpublish topic [payload] : publish a retained message" << endl;
       Console << "      name.view" << endl;
       Console << "      name.delete" << endl;
       Console << endl;
+      Console << "  free : view free mem" << endl;
       Console << "  list : list of free brokers (debug 1 advised)" << endl;
       Console << "  debug #" << endl;
       Console << "  list : get list of free brokers" << endl;
@@ -790,7 +835,8 @@ void eval(string& cmd)
     }
     else
     {
-      while(s[0]==' ') s.erase(0,1);
+      while (s[0] == ' ')
+        s.erase(0, 1);
       if (s.length())
         Console << "Unknown command (" << s.c_str() << ")" << endl;
     }
@@ -811,7 +857,8 @@ void loop()
 
   for (auto &every : everies)
   {
-    if (not every.active) continue;
+    if (not every.active)
+      continue;
     if (every.ms && every.cmd.length() && ms > every.next)
     {
       string cmd(every.cmd);
@@ -821,6 +868,7 @@ void loop()
       {
         every.next += every.ms;
         Console << yellow << "Underrun every #" << e << ", " << (ms - every.next) << "ms late" << endl;
+        Console.fg(white);
         every.underrun = ms + 5000;
       }
     }

library.json

@@ -0,0 +1,20 @@
+{
+    "name": "TinyMqtt",
+    "keywords": [ "ethernet, mqtt, m2m, iot" ],
+    "description": "A lightweight MQTT library for ESP8266 and ESP32, supporting MQTT 3.1.1 with QoS and allowing to create a Mqtt broker",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/hsaturn/TinyMqtt.git"
+    },
+    "dependencies":
+    { "hsaturn/TinyConsole" : "*" },
+    "version": "1.1.4",
+    "exclude": "",
+    "examples": "examples/*/*.ino",
+    "frameworks": "arduino",
+    "platforms": [
+        "atmelavr",
+        "espressif8266",
+        "espressif32"
+    ]
+}

library.json.skeleton

@@ -0,0 +1,20 @@
+{
+    "name": "#name",
+    "keywords": [ "ethernet, mqtt, m2m, iot" ],
+    "description": "#paragraph",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/hsaturn/TinyMqtt.git"
+    },
+    "dependencies":
+    { #dependencies },
+    "version": "#version",
+    "exclude": "",
+    "examples": "examples/*/*.ino",
+    "frameworks": "arduino",
+    "platforms": [
+        "atmelavr",
+        "espressif8266",
+        "espressif32"
+    ]
+}

library.properties

@@ -1,11 +1,11 @@
 name=TinyMqtt
-version=0.9.12
+version=1.1.4
-author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
+author=HSaturn, <hsaturn@gmail.com>
-maintainer=Francois BIOT <hsaturn@gmail.com>
+maintainer=HSaturn <hsaturn@gmail.com>
-sentence=A tiny broker and client library for MQTT messaging.
+sentence=A lightweight broker and client Mqtt library for Arduino and ESP.
-paragraph=MQTT is a lightweight messaging protocol. This library allows to host a broker or to use a mqtt client in your ESP 8266 or 32 WROOM. It does support MQTT 3.1.1 with QoS=0, and is intented to be as smallest as possible, keeping a good efficiency (about 1k msg per second on ESP8266 12F).
+paragraph=TinyMqtt supports MQTT 3.1.1 with QoS and allows to create a Mqtt broker
 category=Communication
 url=https://github.com/hsaturn/TinyMqtt
 architectures=*
-depends=TinyConsole
+depends=hsaturn/TinyConsole
 includes=TinyMqtt.h

src/StringIndexer.h

@@ -107,6 +107,8 @@ class IndexedString
       index = source.index;
     }
 
+    IndexedString(IndexedString&& i) : index(i.index) {}
+
     IndexedString(const char* str, uint8_t len)
     {
       index=StringIndexer::strToIndex(str, len);

src/TinyMqtt.cpp

@@ -9,22 +9,35 @@ static auto red = TinyConsole::red;
 static auto yellow = TinyConsole::yellow;
 
 int TinyMqtt::debug=2;
+
 #endif
 
 #ifdef EPOXY_DUINO
   std::map<MqttMessage::Type, int> MqttClient::counters;
+  int MqttBroker::instances = 0;
+  int MqttClient::instances = 0;
+
 #endif
 
-MqttBroker::MqttBroker(uint16_t port)
+MqttBroker::MqttBroker(uint16_t port, uint8_t max_retain_size)
 {
+  debug("New broker" << port);
+  retain_size = max_retain_size;
   server = new TcpServer(port);
 #ifdef TINY_MQTT_ASYNC
   server->onClient(onClient, this);
 #endif
+#ifdef EPOXY_DUINO
+  instances++;
+#endif
 }
 
 MqttBroker::~MqttBroker()
 {
+#ifdef EPOXY_DUINO
+  instances--;
+#endif
+  closeRemoteBroker();
   while(clients.size())
   {
     auto client = clients[0];
@@ -50,10 +63,11 @@ MqttClient::MqttClient(MqttBroker* local_broker, TcpClient* new_client)
   // client->onConnect() TODO
   // client->onDisconnect() TODO
 #else
-  tcp_client = new WiFiClient(*new_client);
+  tcp_client = new TcpClient(*new_client);
 #endif
 #ifdef EPOXY_DUINO
   alive = millis()+500000;
+  instances++;
 #else
   alive = millis()+5000;  // TODO MAGIC client expires after 5s if no CONNECT msg
 #endif
@@ -66,10 +80,16 @@ MqttClient::MqttClient(MqttBroker* local_broker, const string& id)
   keep_alive = 0;
 
   if (local_broker) local_broker->addClient(this);
+#ifdef EPOXY_DUINO
+  instances++;
+#endif
 }
 
 MqttClient::~MqttClient()
 {
+#ifdef EPOXY_DUINO
+  instances--;
+#endif
   close();
   delete tcp_client;
   debug("*** MqttClient delete()");
@@ -116,7 +136,7 @@ void MqttClient::connect(string broker, uint16_t port, uint16_t ka)
 #ifdef TINY_MQTT_ASYNC
   tcp_client->onData(onData, this);
   tcp_client->onConnect(onConnect, this);
-  tcp_client->connect(broker.c_str(), port, ka);
+  tcp_client->connect(broker.c_str(), port);
 #else
   if (tcp_client->connect(broker.c_str(), port))
   {
@@ -136,12 +156,23 @@ void MqttBroker::addClient(MqttClient* client)
   clients.push_back(client);
 }
 
+void MqttBroker::closeRemoteBroker()
+{
+  if (remote_broker)
+  {
+    delete remote_broker;
+    remote_broker = nullptr;
+  }
+}
+
 void MqttBroker::connect(const string& host, uint16_t port)
 {
   debug("MqttBroker::connect");
+  closeRemoteBroker();
   if (remote_broker == nullptr) remote_broker = new MqttClient;
   remote_broker->connect(host, port);
   remote_broker->local_broker = this;  // Because connect removed the link
+  // TODO shouldn't we resubscribe to all client subscriptions ?
 }
 
 void MqttBroker::removeClient(MqttClient* remove)
@@ -180,7 +211,7 @@ void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
 void MqttBroker::loop()
 {
 #ifndef TINY_MQTT_ASYNC
-  WiFiClient client = server->accept();
+  TcpClient client = server->accept();
 
   if (client)
   {
@@ -211,9 +242,21 @@ void MqttBroker::loop()
   }
 }
 
-MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
+// Obvioulsy called when the broker is connected to another broker.
+MqttError MqttBroker::subscribe(MqttClient* client, const Topic& topic, uint8_t qos)
 {
-  debug("MqttBroker::subscribe");
+  debug("MqttBroker::subscribe to " << topic.str() << ", retained=" << retained.size() );
+  for(auto& retainItem: retained)
+  {
+    auto &retained_topic = retainItem.first;
+    auto &retain = retainItem.second;
+    debug("  retained: " << retained_topic.str());
+    if (topic.matches(retained_topic))
+    {
+      debug("  -> sending");
+      client->publishIfSubscribed(retained_topic, retain.msg);
+    }
+  }
   if (remote_broker && remote_broker->connected())
   {
     return remote_broker->subscribe(topic, qos);
@@ -221,10 +264,12 @@ MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
   return MqttNowhereToSend;
 }
 
-MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const
+MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg)
 {
   MqttError retval = MqttOk;
 
+  retain(topic, msg);
+
   debug("MqttBroker::publish");
   int i=0;
   for(auto client: clients)
@@ -296,23 +341,24 @@ void MqttClient::loop()
 {
   if (keep_alive && (millis() >= alive))
   {
-    if (local_broker)
+    if (tcp_client && tcp_client->connected())
-    {
-      debug(red << "timeout client");
-      close();
-      debug(red << "closed");
-    }
-    else if (tcp_client && tcp_client->connected())
     {
       debug("pingreq");
-      uint16_t pingreq = MqttMessage::Type::PingReq;
+      static MqttMessage pingreq(MqttMessage::Type::PingReq);
-      tcp_client->write((const char*)(&pingreq), 2);
+      pingreq.sendTo(this);
       clientAlive(0);
 
       // TODO when many MqttClient passes through a local broker
       // there is no need to send one PingReq per instance.
     }
+    else if (local_broker)
+    {
+      debug(red << "timeout client");
+      close();
+      debug(red << "closed");
     }
+  }
+
 #ifndef TINY_MQTT_ASYNC
   while(tcp_client && tcp_client->available()>0)
   {
@@ -391,13 +437,13 @@ MqttError MqttClient::subscribe(Topic topic, uint8_t qos)
 
   subscriptions.insert(topic);
 
-  if (local_broker==nullptr) // remote broker
+  if (local_broker==nullptr) // connected to a remote broker
   {
     return sendTopic(topic, MqttMessage::Type::Subscribe, qos);
   }
   else
   {
-    return local_broker->subscribe(topic, qos);
+    return local_broker->subscribe(this, topic, qos);
   }
   return ret;
 }
@@ -568,7 +614,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
             }
             else
               qoss.push_back(qos);
-            subscriptions.insert(topic);
+            subscribe(topic);
           }
           else
           {
@@ -600,6 +646,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
       if (mqtt_connected() or tcp_client == nullptr)
       {
         uint8_t qos = mesg->flags();
+        qos = (qos / 2) & 3;
         payload = header;
         mesg->getString(payload, len);
         Topic published(payload, len);
@@ -607,9 +654,20 @@ void MqttClient::processMessage(MqttMessage* mesg)
         #if TINY_MQTT_DEBUG
           Console << "Received Publish (" << published.str().c_str() << ") size=" << (int)len << endl;
         #endif
-        // << '(' << string(payload, len).c_str() << ')'  << " msglen=" << mesg->length() << endl;
+
-        if (qos) payload+=2;  // ignore packet identifier if any
+        const char* ID;     // remove PublishID() to avoid misuse
+        if (qos) {
+          ID = payload;
+          payload+=2;  // ignore packet identifier if any
+        }
         len=mesg->end()-payload;
+        if (qos == 1)
+        {
+          MqttMessage msg(MqttMessage::Type::PubAck);
+          msg.add(ID[0]);  // MessageID high
+          msg.add(ID[1]);  // MessageID low
+          msg.sendTo(this);
+        }
         // TODO reset DUP
         // TODO reset RETAIN
 
@@ -618,13 +676,13 @@ void MqttClient::processMessage(MqttMessage* mesg)
           #if TINY_MQTT_DEBUG
             if (TinyMqtt::debug >= 2)
             {
-              Console << (isSubscribedTo(published) ? "not" : "") << " subscribed.\n";
+              Console << (isSubscribedTo(published) ? "not" : "") << " subscribed.\r\n";
-              Console << "has " << (callback ? "" : "no ") << " callback.\n";
+              Console << "has " << (callback ? "" : "no ") << " callback.\r\n";
             }
           #endif
           if (callback and isSubscribedTo(published))
           {
-            callback(this, published, payload, len);  // TODO send the real payload
+            callback(this, published, payload, len);
           }
         }
         else if (local_broker) // from outside to inside
@@ -728,9 +786,9 @@ bool Topic::matches(const Topic& topic) const
 
 
 // publish from local client
-MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pay_length)
+MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pay_length, bool retain)
 {
-  MqttMessage msg(MqttMessage::Publish);
+  MqttMessage msg(MqttMessage::Publish, retain ? 1 : 0);
   msg.add(topic);
   msg.add(payload, pay_length, false);
   msg.complete();
@@ -739,7 +797,7 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
   {
     return local_broker->publish(this, topic, msg);
   }
-  else if (tcp_client)
+  else if (tcp_client and connected())
     return msg.sendTo(this);
   else
     return MqttNowhereToSend;
@@ -894,6 +952,40 @@ MqttError MqttMessage::sendTo(MqttClient* client)
   return MqttOk;
 }
 
+void MqttBroker::retainDrop()
+{
+  if (retained.size() >= retain_size)
+  {
+    std::map<Topic, Retain>::iterator oldest = retained.begin();
+    auto it = oldest;
+    while(++it != retained.end())
+    {
+      if (oldest->second.timestamp > it->second.timestamp)
+        oldest = it;
+    }
+    retained.erase(oldest);
+  }
+}
+
+void MqttBroker::retain(const Topic& topic, const MqttMessage& msg)
+{
+  debug("MqttBroker::retain msg_type=" << _HEX(msg.type()) << ", retain_size=" << retain_size);
+  if (retain_size==0 or msg.type() != MqttMessage::Publish) return;
+  if (msg.flags() & 1)  // flag RETAIN
+  {
+    debug("  retaining " << topic.str());
+    auto old = retained.find(topic);
+    if (old == retained.end())
+      retainDrop();
+    else
+      retained.erase(old);
+    // FIXME if payload size == 0 remove message from retained
+    Retain r(micros(), msg);
+    r.msg.retained();
+    retained.insert({ topic, std::move(r)});
+  }
+}
+
 void MqttMessage::hexdump(const char* prefix) const
 {
   (void)prefix;

src/TinyMqtt.h

@@ -1,6 +1,8 @@
 // vim: ts=2 sw=2 expandtab
 #pragma once
 
+#define TINY_MQTT_REVISION "1.1.3"
+
 #ifndef TINY_MQTT_DEBUG
 #define TINY_MQTT_DEBUG 0
 #endif
@@ -8,7 +10,10 @@
 // TODO Should add a AUnit with both TINY_MQTT_ASYNC and not TINY_MQTT_ASYNC
 // #define TINY_MQTT_ASYNC  // Uncomment this to use ESPAsyncTCP instead of normal cnx
 
-#if defined(ESP8266) || defined(EPOXY_DUINO)
+
+#if defined(TINY_MQTT_ETHERNET)
+  #include <Ethernet.h>
+#elif defined(ESP8266) || defined(EPOXY_DUINO)
   #ifdef TINY_MQTT_ASYNC
     #include <ESPAsyncTCP.h>
   #else
@@ -19,6 +24,8 @@
   #ifdef TINY_MQTT_ASYNC
     #include <AsyncTCP.h> // https://github.com/me-no-dev/AsyncTCP
   #endif
+#elif defined(ARDUINO_ARCH_RP2040)
+  #include <WiFi.h>   // works with Raspberry Pi Pico W, earlephilhower
 #endif
 #ifdef EPOXY_DUINO
   #define dbg_ptr uint64_t
@@ -53,6 +60,10 @@
   #define debug(what) {}
 #endif
 
+#if defined(TINY_MQTT_ETHERNET)
+  using TcpClient = EthernetClient;
+  using TcpServer = EthernetServer;
+#else
   #ifdef TINY_MQTT_ASYNC
     using TcpClient = AsyncClient;
     using TcpServer = AsyncServer;
@@ -60,6 +71,7 @@
     using TcpClient = WiFiClient;
     using TcpServer = WiFiServer;
   #endif
+#endif
 
 enum __attribute__((packed)) MqttError
 {
@@ -121,7 +133,10 @@ class MqttMessage
       return (*bun << 8) | bun[1]; }
 
     MqttMessage() { reset(); }
-    MqttMessage(Type t, uint8_t bits_d3_d0=0) { create(t); buffer[0] |= bits_d3_d0; }
+    MqttMessage(Type t, uint8_t bits_d3_d0=0) { create(t); buffer[0] |= (bits_d3_d0 & 0xF); }
+    MqttMessage(const MqttMessage& m)
+      : buffer(m.buffer), vheader(m.vheader), size(m.size), state(m.state) {}
+
     void incoming(char byte);
     void add(char byte) { incoming(byte); }
     void add(const char* p, size_t len, bool addLength=true );
@@ -130,6 +145,7 @@ class MqttMessage
     const char* end() const { return &buffer[0]+buffer.size(); }
     const char* getVHeader() const { return &buffer[vheader]; }
     void complete() { encodeLength(); }
+    void retained() { if ((buffer[0] & 0xF)==Publish) buffer[0] |= 1; }
 
     void reset();
 
@@ -156,6 +172,15 @@ class MqttMessage
     MqttError sendTo(MqttClient*);
     void hexdump(const char* prefix=nullptr) const;
 
+    MqttMessage& operator = (MqttMessage&& m)
+    {
+      buffer = std::move(m.buffer);
+      vheader = m.vheader;
+      size = m.size;
+      state = m.state;
+      return *this;
+    }
+
   private:
     void encodeLength();
 
@@ -197,7 +222,9 @@ class MqttClient
     ~MqttClient();
 
     void connect(MqttBroker* local_broker);
-    void connect(string broker, uint16_t port, uint16_t keep_alive = 10);
+    void connect(string broker, uint16_t port = 1883, uint16_t keep_alive = 10);
+    void connect(const IPAddress& ip, uint16_t port = 1883, uint16_t keep_alive = 10)
+    { connect(ip.toString().c_str(), port, keep_alive); }
 
     // TODO it seems that connected returns true in tcp mode even if
     // no negociation occurred
@@ -228,11 +255,11 @@ class MqttClient
     };
 
     // Publish from client to the world
-    MqttError publish(const Topic&, const char* payload, size_t pay_length);
+    MqttError publish(const Topic&, const char* payload, size_t pay_length, bool retain=false);
-    MqttError publish(const Topic& t, const char* payload) { return publish(t, payload, strlen(payload)); }
+    MqttError publish(const Topic& t, const char* payload, bool retain=false) { return publish(t, payload, strlen(payload), retain); }
-    MqttError publish(const Topic& t, const String& s) { return publish(t, s.c_str(), s.length()); }
+    MqttError publish(const Topic& t, const String& s, bool retain=false) { return publish(t, s.c_str(), s.length(), retain); }
-    MqttError publish(const Topic& t, const string& s) { return publish(t,s.c_str(),s.length());}
+    MqttError publish(const Topic& t, const string& s, bool retain=false) { return publish(t,s.c_str(),s.length(), retain);}
-    MqttError publish(const Topic& t) { return publish(t, nullptr, 0);};
+    MqttError publish(const Topic& t, bool retain=false) { return publish(t, nullptr, 0, retain);};
 
     MqttError subscribe(Topic topic, uint8_t qos=0);
     MqttError unsubscribe(Topic topic);
@@ -275,6 +302,7 @@ class MqttClient
 
 #ifdef EPOXY_DUINO
     static std::map<MqttMessage::Type, int> counters;  // Number of processed messages
+    static int instances;
 #endif
     uint32_t keepAlive() const { return keep_alive; }
 
@@ -317,15 +345,9 @@ class MqttClient
 
 class MqttBroker
 {
-  enum __attribute__((packed)) State
-  {
-    Disconnected,  // Also the initial state
-    Connecting,    // connect and sends a fake publish to avoid circular cnx
-    Connected,     // this->broker is connected and circular cnx avoided
-  };
   public:
     // TODO limit max number of clients
-    MqttBroker(uint16_t port);
+    MqttBroker(uint16_t port, uint8_t retain_size=0);
     ~MqttBroker();
 
     void begin() { server->begin(); }
@@ -334,9 +356,12 @@ class MqttBroker
     /** Connect the broker to a parent broker */
     void connect(const string& host, uint16_t port=1883);
     /** returns true if connected to another broker */
-    bool connected() const { return state == Connected; }
+    bool connected() const { return remote_broker ? remote_broker->connected() : false; }
 
     size_t clientsCount() const { return clients.size(); }
+    uint8_t retain() { return retain_size; }
+    void retain(uint8_t size) { retain_size = size; if (size==0) retained.clear(); }
+    uint8_t retainCount() const { return retained.size(); }
 
     void dump(string indent="")
     {
@@ -345,6 +370,9 @@ class MqttBroker
     }
 
     const std::vector<MqttClient*>  getClients() const { return clients; }
+#ifdef EPOXY_DUINO
+    static int instances;
+#endif
 
   private:
     friend class MqttClient;
@@ -356,10 +384,9 @@ class MqttBroker
     bool checkPassword(const char* password, uint8_t len) const
     { return compareString(auth_password, password, len); }
 
+    MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg);
 
-    MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const;
+    MqttError subscribe(MqttClient*, const Topic& topic, uint8_t qos);
-
-    MqttError subscribe(const Topic& topic, uint8_t qos);
 
     // For clients that are added not by the broker itself (local clients)
     void addClient(MqttClient* client);
@@ -375,5 +402,27 @@ class MqttBroker
     const char* auth_password = "guest";
     MqttClient* remote_broker = nullptr;
 
-    State state = Disconnected;
+    void closeRemoteBroker();
+
+    void retain(const Topic& topic, const MqttMessage& msg);
+    void retainDrop();
+
+    struct Retain
+    {
+      Retain(unsigned long ts, const MqttMessage& m) : timestamp(ts), msg(m) {}
+      Retain(Retain&& r) : timestamp(r.timestamp), msg(std::move(r.msg)) {}
+
+      Retain& operator=(Retain&& r)
+      {
+        timestamp = r.timestamp;
+        msg = std::move(r.msg);
+        return *this;
+      }
+
+      unsigned long timestamp;
+      MqttMessage msg;
+    };
+
+    std::map<Topic, Retain> retained;
+    uint8_t retain_size;
 };

tests/Makefile.opts

@@ -1,7 +1,7 @@
 
 # GCC
 # CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
-EXTRA_CXXFLAGS=-g3 -O0
+EXTRA_CXXFLAGS=-g3 -O0 -std=c++17
 
 CXXFLAGS=-D_GNU_SOURCE -Werror=return-type -std=gnu++17 -Wall -g3 -O0
 

tests/compile-test/Makefile

@@ -1,11 +1,23 @@
-# See https://github.com/bxparks/EpoxyDuino for documentation about this
+# vim: noexpandtab
-# Makefile to compile and run Arduino programs natively on Linux or MacOS.
 
-include ../Makefile.opts
 
-APP_NAME := tinymqtt-test
+APP_NAME := compile-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi  ESPAsync ESP8266mDNS TinyConsole
 ARDUINO_LIB_DIRS := ../../../EspMock/libraries
 EPOXY_CORE := EPOXY_CORE_ESP8266
 DUMMY := 1
-include ../../../EpoxyDuino/EpoxyDuino.mk
+RUN = no
+APP_SRCS_COMP += $(shell find ../../examples -name "*.ino")
+APP_SRCS_CPP += $(APP_SRCS_COMP:%.ino=%.o)
+CXXFLAGS = -D_GNU_SOURCE -Werror=return-type -std=gnu++17 -Wall -g3 -O0 -DEPOXY_DUINO
+
+include ../Makefile.opts
+
+all:
+
+compile-tests.out: $(OBJS)
+
+run:
+	@echo "No run for compile tests"
+	exit 0
+

tests/compile-test/tinymqtt-test.ino

@@ -1,848 +0,0 @@
-// vim: ts=2 sw=2 expandtab smartindent
-#include <TinyConsole.h>
-#include <TinyMqtt.h>       // https://github.com/hsaturn/TinyMqtt
-#include <TinyStreaming.h>
-
-#include <sstream>
-#include <string>
-#include <map>
-
-using string = TinyConsole::string;
-
-bool echo_on = true;
-auto green = TinyConsole::green;
-auto red = TinyConsole::red;
-auto white = TinyConsole::white;
-auto cyan = TinyConsole::cyan;
-auto yellow = TinyConsole::yellow;
-auto magenta = TinyConsole::magenta;
-auto save_cursor = TinyConsole::save_cursor;
-auto restore_cursor = TinyConsole::restore_cursor;
-auto erase_to_end = TinyConsole::erase_to_end;
-
-const char* ssid = "";
-const char* password = "";
-
-struct free_broker
-{
-  public:
-    free_broker(const char* s, uint16_t p, const char* /* comment */) : url(s), port(p) {}
-
-    string url;
-    uint16_t port;
-};
-
-const std::map<string, free_broker> list =
-{
-  { "mqtthq", { "public.mqtthq.com" , 8083, "publish/subscribe" }},
-  { "hivemq", { "broker.hivemq.com", 1883, "" }}
-};
-
-/** Very complex example
-  * Console allowing to make any kind of test,
-  * even some stress tests.
-  *
-  * Upload the sketch, the use the terminal.
-  * Press H for mini help.
-  *
-  * tested with mqtt-spy-0.5.4
-  * TODO examples of scripts
-  */
-
-void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
-{
-  Console << cyan << "--> " << srce->id().c_str() << ": received " << topic.c_str() << white;
-  if (payload)
-  {
-    Console << ", payload[" << length << "]=[";
-    while(length--)
-    {
-      const char c=*payload++;
-      if (c<32)
-        Console << '?';
-      else
-        Console << c;
-    }
-    Console << ']' << endl;
-  }
-}
-
-std::map<string, MqttClient*> clients;
-std::map<string, MqttBroker*> brokers;
-std::map<string, string> vars;
-
-void eval(string& cmd);
-
-void replace(const char* d, string& str, string srch, string to)
-{
-  if (d[0] && d[1])
-  {
-    srch=d[0]+srch+d[1];
-    to=d[0]+to+d[1];
-
-    size_t pos = 0;
-    while((pos=str.find(srch, pos)) != string::npos)
-    {
-      str.erase(pos, srch.length());
-      str.insert(pos, to);
-      pos += to.length()-1;
-    }
-  }
-}
-
-void replaceVars(string& cmd)
-{
-  cmd = ' '+cmd+' ';
-
-  for(auto it: vars)
-  {
-    replace("..", cmd, it.first, it.second);
-    replace(". ", cmd, it.first, it.second);
-    replace(" .", cmd, it.first, it.second);
-    replace("  ", cmd, it.first, it.second);
-  }
-  cmd.erase(0, cmd.find_first_not_of(' '));
-  cmd.erase(cmd.find_last_not_of(' ')+1);
-
-}
-
-void onCommand(const string& command)
-{
-  Console << endl;
-  string cmd=command;
-  if (cmd.substr(0,3)!="set") replaceVars(cmd);
-  eval(cmd);
-  Console << endl;
-  Console.prompt();
-}
-
-void setup()
-{
-  Serial.begin(115200);
-  Console.begin(Serial);
-  Console.setPrompt("> ");
-  Console.setCallback(onCommand);
-  delay(500);
-
-  Console.cls();
-  Console << endl << endl;
-  Console << yellow
-          << "***************************************************************" << endl;
-  Console << "*  Welcome to the TinyMqtt console" << endl;
-  Console << "*  The console allows to test all features of the libraries." << endl;
-  Console << "*  Enter help to view the list of commands." << endl;
-  Console << "***************************************************************" << endl;
-  Console << endl;
-  if (strlen(ssid)==0)
-    Console << red << "*  ERROR: You must modify ssid/password in order" << endl
-                   << "          to be able to connect to your Wifi network." << endl;
-  Console << endl << white;
-
-  Console << "Connecting to '" << ssid << "' ";
-
-  WiFi.mode(WIFI_STA);
-  WiFi.begin(ssid, password);
-  WiFi.mode(WIFI_STA);
-  WiFi.begin(ssid, password);
-
-  while (WiFi.status() != WL_CONNECTED)
-  { Console << '-'; delay(500); }
-
-  Console << endl << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
-
-  const char* name="tinytest";
-  Console << "Starting MDNS, name= " << name;
-
-  MqttBroker* broker = new MqttBroker(1883);
-  broker->begin();
-  brokers["broker"] = broker;
-
-  if (Console.isTerm()) onCommand("every 333 view");
-}
-
-string getword(string& str, const char* if_empty=nullptr, char sep=' ');
-
-int getint(string& str, const int if_empty=0)
-{
-  string str2=str;
-  string sword = getword(str);
-  if (sword[0] and isdigit(sword[0]))
-  {
-    int ret=atoi(sword.c_str());
-    while(isdigit(sword[0]) or sword[0]==' ') sword.erase(0,1);
-    if (sword.length()) str = sword+' '+str;
-    return ret;
-  }
-  str=str2;
-  return if_empty;
-}
-
-string getword(string& str, const char* if_empty/*=nullptr*/, char sep/*=' '*/)
-{
-  char quote=(str[0]=='"' or str[0]=='\'' ? str[0] : 0);
-  if (quote) str.erase(0,1);
-  string sword;
-  while(str.length() and (str[0]!=sep or quote))
-  {
-    if (str[0]==quote)
-    {
-      str.erase(0,1);
-      break;
-    }
-    sword += str[0];
-    str.erase(0,1);
-  }
-  while(str[0]==sep) str.erase(0,1);
-  if (if_empty and sword.length()==0) return if_empty;
-  if (quote==false and sword.length()>=4 and sword.substr(0,3)=="rnd")
-  {
-    sword.erase(0,3);
-    if (sword[0]=='(')
-    {
-      int to = 100;
-      sword.erase(0,1);
-      int from=getint(sword);
-      if (sword[0]==',')
-      {
-        sword.erase(0,1);
-        to = getint(sword);
-        if (sword[0]!=')') Console << "Missing ')'" << endl;
-      }
-      else
-      {
-        to=from;
-        from=0;
-      }
-      return String(random(from,to)).c_str();
-    }
-    else
-    {
-      Console << "Missing '('" << endl;
-    }
-  }
-  while(str[0]==' ') str.erase(0,1);
-  return sword;
-}
-
-bool isaddr(string s)
-{
-  if (s.length()==0 or s.length()>3) return false;
-  for(char c: s)
-    if (c<'0' or c>'9') return false;
-  return true;
-}
-
-string getip(string& str, const char* if_empty=nullptr, char sep=' ')
-{
-  string addr=getword(str, if_empty, sep);
-  string ip=addr;
-  std::vector<string> build;
-  while(ip.length())
-  {
-    string b=getword(ip,nullptr,'.');
-    if (isaddr(b) && build.size()<4)
-    {
-      build.push_back(b);
-    }
-    else
-      return addr;
-  }
-  IPAddress local=WiFi.localIP();
-  addr.clear();
-  while(build.size()!=4)
-  {
-    std::stringstream b;
-    b << (int)local[3-build.size()];
-    build.insert(build.begin(), b.str().c_str());
-  }
-  for(string s: build)
-  {
-    if (addr.length()) addr += '.';
-    addr += s;
-  }
-  Console << "connect address: " << addr << endl;
-  return addr;
-}
-
-std::set<string> commands = {
-  "broker", "blink", "client", "connect",
-  "create", "delete", "debug", "help", "interval",
-  "list", "ls", "ip", "off", "on", "set",
-  "publish", "reset", "subscribe", "unsubscribe", "view", "echo", "every"
-};
-
-void convertToCommand(string& search)
-{
-  while(search[0]==' ') search.erase(0,1);
-  if (search.length()==0) return;
-  string matches;
-  int count=0;
-  for(string cmd: commands)
-  {
-    if (cmd.substr(0, search.length()) == search)
-    {
-      if (count) matches +=", ";
-      count++;
-      matches += cmd;
-    }
-  }
-  if (count==1)
-    search = matches;
-  else if (count>1)
-  {
-    Console << "Ambiguous command: " << matches << endl;
-    search.clear();
-  }
-}
-
-bool compare(string s, const char* cmd)
-{
-  uint8_t p=0;
-  while(s[p++]==*cmd++)
-  {
-    if (*cmd==0 or s[p]==0) return true;
-    if (s[p]==' ') return true;
-  }
-  return false;
-}
-
-using ClientFunction = void(*)(string& cmd, MqttClient* publish);
-
-struct Every
-{
-  string cmd;
-  uint32_t ms;
-  uint32_t next;
-  uint32_t underrun=0;
-  bool active=true;
-
-  void dump()
-  {
-    if (active)
-      Console << green << "enabled";
-    else
-      Console << red << "disabled";
-
-    auto mill=millis();
-    Console << white << ms << "ms [" << cmd << "] next in ";
-    if (mill > next)
-      Console << "now";
-    else
-      Console << next-mill << "ms";
-  }
-};
-
-uint32_t blink_ms_on[16];
-uint32_t blink_ms_off[16];
-uint32_t blink_next[16];
-bool blink_state[16];
-int16_t blink;
-
-std::vector<Every> everies;
-
-void clientConnect(MqttClient* client, string& cmd)
-{
-  string remote = getword(cmd);
-  uint16_t port;
-  auto it=list.find(remote);
-  if (it != list.end())
-  {
-    Console << "Connecting to free broker: " << remote << endl;
-    remote = it->second.url;
-    port=it->second.port;
-  }
-  else
-    port=getint(cmd);
-
-  client->connect(remote.c_str(), port, getint(cmd, 60));
-  Console << (client->connected() ? "connected." : "not connected") << endl;
-}
-
-void eval(string& cmd)
-{
-  while(cmd.length())
-  {
-    MqttError retval = MqttOk;
-
-    string s;
-    MqttBroker* broker = nullptr;
-    MqttClient* client = nullptr;
-
-    // client.function notation
-    if (cmd.find('.') != string::npos &&
-        cmd.find('.') < cmd.find(' '))
-    {
-      s=getword(cmd, nullptr, '.');
-
-      if (s.length())
-      {
-        if (clients.find(s) != clients.end())
-        {
-          client = clients[s];
-        }
-        else if (brokers.find(s) != brokers.end())
-        {
-          broker = brokers[s];
-        }
-        else
-        {
-          Console << red << "Unknown class (" << s.c_str() << ")" << white << endl;
-          cmd.clear();
-        }
-      }
-    }
-
-    s = getword(cmd);
-    if (s.length()) convertToCommand(s);
-    if (s.length()==0)
-    {}
-    else if (compare(s, "debug"))
-    {
-#if TINY_MQTT_DEBUG
-      TinyMqtt::debug = getint(cmd);
-#else
-      Console << red << "TinyMqtt not compiled in debug" << endl;
-#endif
-    }
-    else if (compare(s, "list"))
-    {
-      Console << "List of free servers" << endl;
-      for(const auto& fb: list)
-      {
-        Console << "  " << fb.first << " : " << fb.second.url << ":" << fb.second.port << endl;
-      }
-    }
-    else if (compare(s, "delete"))
-    {
-      if (client==nullptr && broker==nullptr)
-      {
-        s = getword(cmd);
-        if (clients.find(s) != clients.end())
-        {
-          client = clients[s];
-        }
-        else if (brokers.find(s) != brokers.end())
-        {
-          broker = brokers[s];
-        }
-        else
-          Console << red << "Unable to find (" << s.c_str() << ")" << white << endl;
-      }
-      if (client)
-      {
-        for (auto it: clients)
-        {
-          if (it.second != client) continue;
-          Console << "deleted" << endl;
-          delete (it.second);
-          clients.erase(it.first);
-          break;
-        }
-        cmd += " ls";
-      }
-      else if (broker)
-      {
-        for(auto it: brokers)
-        {
-          if (broker != it.second) continue;
-          Console << "deleted" << endl;
-          delete (it.second);
-          brokers.erase(it.first);
-          break;
-        }
-        cmd += " ls";
-      }
-      else
-        Console << "Nothing to delete" << endl;
-    }
-    else if (broker)
-    {
-      if (compare(s,"connect"))
-      {
-        Console << "NYI" << endl;
-      }
-      else if (compare(s, "view"))
-      {
-        broker->dump();
-      }
-      else
-      {
-        Console << "Unknown broker command (" << s << ")" << endl;
-        s.clear();
-      }
-    }
-    else if (client)
-    {
-      if (compare(s,"connect"))
-      {
-        clientConnect(client, cmd);
-      }
-      else if (compare(s,"publish"))
-      {
-        retval = client->publish(getword(cmd), getword(cmd));
-      }
-      else if (compare(s,"subscribe"))
-      {
-        client->subscribe(getword(cmd));
-      }
-      else if (compare(s, "unsubscribe"))
-      {
-        client->unsubscribe(getword(cmd));
-      }
-      else if (compare(s, "view"))
-      {
-        client->dump();
-      }
-      else
-      {
-        Console << "Unknown client command (" << s << ")" << endl;
-        s.clear();
-      }
-    }
-    else if (compare(s, "on"))
-    {
-      uint8_t pin=getint(cmd, 2);
-      pinMode(pin, OUTPUT);
-      digitalWrite(pin, HIGH);
-    }
-    else if (compare(s, "off"))
-    {
-      uint8_t pin=getint(cmd, 2);
-      pinMode(pin, OUTPUT);
-      digitalWrite(pin, LOW);
-    }
-    else if (compare(s, "echo"))
-    {
-      s=getword(cmd);
-      if (s=="on")
-        echo_on = true;
-      else if (s=="off")
-        echo_on = false;
-      else
-      {
-        Console << s << ' ';
-        while(cmd.length())
-        {
-          Console << getword(cmd) << ' ';
-        }
-      }
-    }
-    else if (compare(s, "every"))
-    {
-      uint32_t ms = getint(cmd, 0);
-      if (ms)
-      {
-        if (cmd.length())
-        {
-          Every every;
-          every.ms=ms;
-          every.cmd=cmd;
-          every.next=millis()+ms;
-          everies.push_back(every);
-          every.dump();
-          Console << endl;
-          cmd.clear();
-        }
-      }
-      else if (compare(cmd, "off") or compare(cmd, "on"))
-      {
-        bool active=getword(cmd)=="on";
-        uint8_t ever=getint(cmd, 100);
-        uint8_t count=0;
-        for(auto& every: everies)
-        {
-          if (count==ever or (ever==100))
-          {
-            if (every.active != active)
-            {
-              Console << "every #" << count << (active ? " on" :" off") << endl;
-              every.active = active;
-              every.underrun = 0;
-            }
-          }
-          count++;
-        }
-      }
-      else if (compare(cmd, "list") or cmd.length()==0)
-      {
-        getword(cmd);
-        Console << "List of everies (ms=" << millis() << ")" << endl;
-        uint8_t count=0;
-        for(auto& every: everies)
-        {
-          Console << count << ": ";
-          every.dump();
-          Console << endl;
-          count++;
-        }
-      }
-      else if (compare(cmd, "remove"))
-      {
-        Console << "Removing..." << endl;
-        getword(cmd);
-        int8_t every=getint(cmd, -1);
-        if (every==-1 and compare(cmd, "last") and everies.size())
-        {
-          getword(cmd);
-          everies.erase(everies.begin()+everies.size()-1);
-        }
-        else if (every==-1 and compare(cmd, "all"))
-        {
-          getword(cmd);
-          everies.clear();
-        }
-        else if (everies.size() > (uint8_t)every)
-        {
-          everies.erase(everies.begin()+every);
-        }
-        else
-          Console << "Bad colmmand" << endl;
-      }
-      else
-        Console << "Bad command" << endl;
-    }
-    else if (compare(s, "blink"))
-    {
-      int8_t blink_nr = getint(cmd, -1);
-      if (blink_nr >= 0)
-      {
-        blink_ms_on[blink_nr]=getint(cmd, blink_ms_on[blink_nr]);
-        blink_ms_off[blink_nr]=getint(cmd, blink_ms_on[blink_nr]);
-        pinMode(blink_nr, OUTPUT);
-        blink_next[blink_nr] = millis();
-        Console << "Blink " << blink_nr << ' ' << (blink_ms_on[blink_nr] ? "on" : "off") << endl;
-        if (blink_ms_on[blink_nr])
-          blink |= 1<< blink_nr;
-        else
-        {
-          blink &= ~(1<< blink_nr);
-        }
-      }
-    }
-    else if (compare(s, "broker"))
-    {
-      string id=getword(cmd);
-      if (clients.find(id) != clients.end())
-      {
-        Console << "A client already have that name" << endl;
-        cmd.clear();
-      }
-      else if (id.length() or brokers.find(id)!=brokers.end())
-      {
-        int port=getint(cmd, 0);
-        if (port)
-        {
-          MqttBroker* broker = new MqttBroker(port);
-          broker->begin();
-
-          brokers[id] = broker;
-          Console << "new broker (" << id.c_str() << ")" << endl;
-        }
-        else
-        {
-          Console << "Missing port" << endl;
-          cmd.clear();
-        }
-      }
-      else
-      {
-        Console << "Missing or existing broker name (" << id.c_str() << ")" << endl;
-        cmd.clear();
-      }
-    }
-    else if (compare(s, "client"))
-    {
-      string id=getword(cmd);
-      if (brokers.find(id) != brokers.end())
-      {
-        Console << "A broker have that name" << endl;
-        cmd.clear();
-      }
-      else if (id.length() or clients.find(id)!=clients.end())
-      {
-        s=getword(cmd);  // broker
-        if (s=="" or brokers.find(s) != brokers.end() or list.find(s) != list.end())
-        {
-          MqttBroker* broker = nullptr;
-          if (s.length()) broker = brokers[s];
-          MqttClient* client = new MqttClient(broker, id);
-          clients[id]=client;
-          client->setCallback(onPublish);
-          if (list.find(s) != list.end())
-          {
-            cmd=s+' '+cmd;
-            clientConnect(client, cmd);
-          }
-          Console << "new client (" << id.c_str() << ", " << s.c_str() << ')' << endl;
-        }
-        else if (s.length())
-        {
-          Console << " not found." << endl;
-          cmd.clear();
-        }
-      }
-      else
-      {
-        Console << "Missing or existing client name" << endl;
-        cmd.clear();
-      }
-    }
-    else if (compare(s, "set"))
-    {
-      string name(getword(cmd));
-      if (name.length()==0)
-      {
-        for(auto it: vars)
-        {
-          Console << "  " << it.first << " -> " << it.second << endl;
-        }
-      }
-      else if (commands.find(name) != commands.end())
-      {
-        Console << "Reserved keyword (" << name << ")" << endl;
-        cmd.clear();
-      }
-      else
-      {
-        if (cmd.length())
-        {
-          vars[name] = cmd;
-          cmd.clear();
-        }
-        else if (vars.find(name) != vars.end())
-          vars.erase(vars.find(name));
-      }
-    }
-    else if (compare(s, "ls") or compare(s, "view"))
-    {
-      bool view = compare(s, "view");
-      if (view)
-      {
-        Console << save_cursor << magenta;
-        Console.gotoxy(1,1);
-      }
-      Console << "--< " << '/' << clients.size() << " client/s. >--" << erase_to_end << endl;
-      for(auto it: clients)
-      {
-        it.second->dump("  ");
-      }
-
-      Console << "--< " << brokers.size() << " brokers/s. >--" << erase_to_end << endl;
-      for(auto it: brokers)
-      {
-        Console << "  +-- '" << it.first.c_str() << "' " << it.second->clientsCount() << " client/s."<< erase_to_end << endl;
-        it.second->dump("     ");
-      }
-      if (view)
-      {
-        Console.bg(white);
-        Console << erase_to_end << restore_cursor;
-      }
-    }
-    else if (compare(s, "reset"))
-      ESP.restart();
-    else if (compare(s, "ip"))
-      Console << "IP: " << WiFi.localIP() << endl;
-    else if (compare(s,"help"))
-    {
-      Console << "syntax:" << endl;
-      Console << "  MqttBroker:" << endl;
-      Console << "    broker {broker_name} {port} : create a new broker" << endl;
-      Console << "      broker_name can be one of 'list'" << endl;
-      Console << "      broker_name.delete : delete a broker (buggy)" << endl;
-      Console << "      broker_name.view   : dump a broker" << endl;
-      Console << endl;
-      Console << "  MqttClient:" << endl;
-      Console << "    client {name} {broker} : create a client then" << endl;
-      Console << "      name.connect  [ip] [port] [alive]" << endl;
-      Console << "      name.[un]subscribe topic" << endl;
-      Console << "      name.publish topic [payload]" << endl;
-      Console << "      name.view" << endl;
-      Console << "      name.delete" << endl;
-      Console << endl;
-      Console << "  list : list of free brokers (debug 1 advised)" << endl;
-      Console << "  debug #" << endl;
-      Console << "  list : get list of free brokers" << endl;
-      Console << "  blink [Dx on_ms off_ms]    : make pin blink" << endl;
-      Console << "  ls / ip / reset" << endl;
-      Console << "  set [name][value]" << endl;
-      Console << "  !  repeat last command" << endl;
-      Console << endl;
-      Console << "  echo [on|off] or strings" << endl;
-      Console << "  every ms [command]; every list; every remove [nr|all]; every (on|off) [#]" << endl;
-      Console << "  on {output}; off {output}" << endl;
-      Console << "  $id : name of the client." << endl;
-      Console << "  rnd[(min[,max])] random number." << endl;
-      Console << endl;
-    }
-    else
-    {
-      while(s[0]==' ') s.erase(0,1);
-      if (s.length())
-        Console << "Unknown command (" << s.c_str() << ")" << endl;
-    }
-
-    if (retval != MqttOk)
-    {
-      Console << "# MQTT ERROR " << retval << endl;
-    }
-  }
-}
-
-void loop()
-{
-  auto ms=millis();
-  int8_t out=0;
-  int16_t blink_bits = blink;
-  uint8_t e=0;
-
-  for(auto& every: everies)
-  {
-    if (not every.active) continue;
-    if (every.ms && every.cmd.length() && ms > every.next)
-    {
-      string cmd(every.cmd);
-      eval(cmd);
-      every.next += every.ms;
-      if (ms > every.next and ms > every.underrun)
-      {
-        every.next += every.ms;
-        Console << yellow << "Underrun every #" << e << ", " <<  (ms - every.next) << "ms late" << endl;
-        every.underrun = ms+5000;
-      }
-    }
-    e++;
-  }
-
-  while(blink_bits)
-  {
-    if (blink_ms_on[out] and ms > blink_next[out])
-    {
-      if (blink_state[out])
-      {
-        blink_next[out] += blink_ms_on[out];
-        digitalWrite(out, LOW);
-      }
-      else
-      {
-        blink_next[out] += blink_ms_off[out];
-        digitalWrite(abs(out), HIGH);
-      }
-      blink_state[out] = not blink_state[out];
-    }
-    blink_bits >>=1;
-    out++;
-  }
-
-#if defined(ESP9266)
-  MDNS.update();
-#endif
-
-  for(auto it: brokers)
-    it.second->loop();
-
-  for(auto it: clients)
-    it.second->loop();
-
-  Console.loop();
-}

tests/local-tests/local-tests.ino

@@ -18,14 +18,14 @@ MqttBroker broker(1883);
 
 std::map<string, std::map<Topic, int>>  published;    // map[client_id] => map[topic] = count
 
-const char* lastPayload;
+std::string lastPayload;
 size_t lastLength;
 
 void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
 {
   if (srce)
     published[srce->id()][topic]++;
-  lastPayload = payload;
+  lastPayload = std::string(payload, length);
   lastLength = length;
 }
 
@@ -51,6 +51,7 @@ test(local_client_should_unregister_when_destroyed)
 
 test(local_client_do_not_disconnect_after_publishing_and_long_inactivity)
 {
+  published.clear();
   EpoxyTest::set_millis(0);
   MqttBroker broker(1883);
   MqttClient client(&broker, "client");
@@ -121,6 +122,25 @@ test(local_publish_should_be_dispatched)
   assertEqual(published[""]["a/c"], 2);
 }
 
+test(hudge_payload)
+{
+  published.clear();
+  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);
+  assertEqual(broker.clientsCount(), (size_t)1);
+  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.c_str());
+  assertEqual(lastLength, strlen(payload));
+  assertEqual(strncmp(payload, lastPayload.c_str(), lastLength), 0);
+}
+
 test(local_publish_should_be_dispatched_to_local_clients)
 {
   published.clear();

tests/network-tests/network-tests.ino

@@ -85,7 +85,7 @@ std::map<string, std::map<Topic, int>>  published;    // map[client_id] => map[t
 char* lastPayload = nullptr;
 size_t lastLength;
 
-void start_servers(int n, bool early_accept = true)
+void start_many_wifi_esp(int n, bool early_accept = true)
 {
     ESP8266WiFiClass::resetInstances();
     ESP8266WiFiClass::earlyAccept = early_accept;
@@ -107,7 +107,7 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
   lastLength = length;
 }
 
-test(network_single_broker_begin)
+test(single_broker_begin)
 {
   assertEqual(WiFi.status(), WL_CONNECTED);
 
@@ -119,7 +119,7 @@ test(network_single_broker_begin)
 
 test(suback)
 {
-  start_servers(2, true);
+  start_many_wifi_esp(2, true);
   assertEqual(WiFi.status(), WL_CONNECTED);
 
   MqttBroker broker(1883);
@@ -144,10 +144,97 @@ test(suback)
   assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
 }
 
-test(network_client_keep_alive_high)
+test(remote_client_deletion)
+{
+  assertEqual(MqttClient::instances, 0);
+  {
+    start_many_wifi_esp(3, true);
+    assertEqual(WiFi.status(), WL_CONNECTED);
+
+    MqttBroker broker(1883);
+    broker.begin();
+    IPAddress broker_ip = WiFi.localIP();
+
+    // A first remote client
+    ESP8266WiFiClass::selectInstance(2);
+    MqttClient remote_client;
+    assertEqual(MqttClient::instances, 1);
+
+    remote_client.connect(broker_ip.toString().c_str());
+    broker.loop(); remote_client.loop();
+    assertEqual(MqttClient::instances, 2);  // broker creates a client to manage remote_client
+
+    // A second remote client
+    ESP8266WiFiClass::selectInstance(3);
+    MqttClient secund_client;
+    assertEqual(MqttClient::instances, 3);
+
+    secund_client.connect(broker_ip.toString().c_str());
+    broker.loop(); remote_client.loop();
+    assertEqual(MqttClient::instances, 4);
+
+    // Now disconnect remote clients
+    remote_client.close();
+    broker.loop(); remote_client.loop();
+    assertEqual(MqttClient::instances, 3);
+
+    secund_client.close();
+    broker.loop(); remote_client.loop();
+    assertEqual(MqttClient::instances, 2);  // These instances are in this scope
+
+    // Now simulate that the external client is dead without disconnecting
+    secund_client.connect(broker_ip.toString().c_str());
+    broker.loop(); remote_client.loop();
+    assertEqual(MqttClient::instances, 3);
+
+    WiFi.disconnect();
+    broker.loop(); remote_client.loop();
+    broker.loop(); remote_client.loop();
+    assertEqual(MqttClient::instances, 2);
+
+  }
+
+  assertEqual(MqttClient::instances, 0);
+}
+
+test(broker_connect_and_client_deletion)
+{
+  assertEqual(MqttClient::instances, 0);
+  {
+    start_many_wifi_esp(2, true);
+    assertEqual(WiFi.status(), WL_CONNECTED);
+
+    MqttBroker broker(1883);
+    broker.begin();
+
+    ESP8266WiFiClass::selectInstance(2);
+    MqttBroker remote_broker(1883);
+    remote_broker.begin();
+    IPAddress remote_broker_ip = WiFi.localIP();
+    assertEqual(MqttClient::instances, 0);
+
+    ESP8266WiFiClass::selectInstance(1);
+    broker.connect(remote_broker_ip.toString().c_str());
+    remote_broker.loop();
+    assertEqual(remote_broker.clientsCount(), (size_t)1);
+
+    // Here, we have two MqttClient
+    // The client that connects broker to remote_broker
+    // The client created by remote_broker
+    assertEqual(MqttClient::instances, 2);
+
+    broker.connect("");
+    remote_broker.loop(); broker.loop();
+    remote_broker.loop(); broker.loop();
+    assertEqual(remote_broker.clientsCount(), (size_t)0);
+  }
+  assertEqual(MqttClient::instances, 0);
+}
+
+test(client_keep_alive_high)
 {
   const uint32_t keep_alive=1000;
-  start_servers(2, true);
+  start_many_wifi_esp(2, true);
   assertEqual(WiFi.status(), WL_CONNECTED);
 
   MqttBroker broker(1883);
@@ -179,9 +266,153 @@ test(network_client_keep_alive_high)
 
 }
 
-test(network_client_to_broker_connexion)
+test(retained_message)
 {
-  start_servers(2, true);
+  published.clear();
+
+  start_many_wifi_esp(2, true);
+  assertEqual(WiFi.status(), WL_CONNECTED);
+
+  MqttBroker broker(1883);
+  broker.begin();
+  broker.retain(10);
+  IPAddress broker_ip = WiFi.localIP();
+
+  MqttClient local_client(&broker, "sender");
+
+  // Send a retained message
+  // No remote client connected
+  local_client.publish("topic", "retained once", true);
+  for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
+
+  // Send a second message on the same topic (issue 86)
+  local_client.publish("topic", "retained once", true);
+  for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
+
+  // Send a second message on the same topic (issue 86)
+  local_client.publish("topic", "retained last", true);
+  for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
+
+  // No connect a client from 2nd Esp
+  ESP8266WiFiClass::selectInstance(2);
+  MqttClient remote_client("receiver");
+  remote_client.connect(broker_ip, 1883);
+  remote_client.setCallback(onPublish);
+
+  assertTrue(remote_client.connected());
+  for(int i=0; i<10; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
+  assertEqual(broker.clientsCount(), (size_t) 2);
+
+  // Should not have received anything yet
+  assertEqual(published.size(), (size_t)0);
+
+  // Now, remote client subscribes to topic
+  remote_client.subscribe("#");
+  for(int i=0; i<10; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
+
+  // Check that the retained message is published once
+  assertEqual(published.size(), (size_t)1);
+  assertEqual(published["receiver"]["topic"], 1);
+
+  // FIXME we should check that
+  // 1 - Retained message has the retain flag set
+  // 2 - Published retained messages that are send normally have their retain flag off
+
+  // The next part of this test does not pass yet (due to remote_client.close()
+  // that does not work well.
+  return;
+
+  // Now remove the retained message
+  remote_client.close();
+  for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
+  assertFalse(remote_client.connected());
+  assertEqual(broker.clientsCount(), (size_t) 1);
+
+  // Disconnect / reconnect the remote clien that should receive again the message
+  remote_client.connect(broker_ip, 1883);
+  remote_client.subscribe("topic");
+  assertTrue(remote_client.connected());
+  for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
+  assertEqual(broker.clientsCount(), (size_t) 2);
+  assertEqual(published.size(), (size_t)2);
+
+  // Remove the retained message now
+  local_client.publish("topic", "", true);
+  assertEqual(published.size(), (size_t)1);
+
+  // And reconnect the remote client
+  remote_client.connect(broker_ip, 1883);
+  for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
+  assertEqual(broker.clientsCount(), (size_t) 2);
+
+  // check that the message was received
+  assertEqual(published.size(), (size_t)2);
+}
+
+test(retained_payload)  // # issue #84
+{
+  published.clear();
+
+  start_many_wifi_esp(2, true);
+  assertEqual(WiFi.status(), WL_CONNECTED);
+
+  MqttBroker broker(1883);
+  broker.begin();
+  broker.retain(10);
+  IPAddress broker_ip = WiFi.localIP();
+
+  MqttClient local_client(&broker, "sender");
+
+  // Send a retained message
+  // No remote client connected
+  local_client.publish("topic", "retained", true);
+  for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
+
+  // No connect a client from 2nd Esp
+  ESP8266WiFiClass::selectInstance(2);
+  MqttClient remote_client("receiver");
+  remote_client.connect(broker_ip, 1883);
+  remote_client.setCallback(onPublish);
+  remote_client.subscribe("#");
+
+  assertTrue(remote_client.connected());
+  for(int i=0; i<10; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
+
+  // Check that the retained message is published
+  assertEqual(lastPayload, "retained");
+}
+
+test(remote_client_disconnect_reconnect)
+{
+  published.clear();
+  start_many_wifi_esp(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, 1883);
+
+  for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
+  assertEqual(broker.clientsCount(), (size_t) 1);
+
+  // Disconnect the client
+  client.close();
+  for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
+  assertEqual(broker.clientsCount(), (size_t) 0);
+
+  // Reconnect the client
+  client.connect(broker_ip, 1883);
+  for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
+  assertEqual(broker.clientsCount(), (size_t) 1);
+}
+
+test(client_to_broker_connexion)
+{
+  start_many_wifi_esp(2, true);
   assertEqual(WiFi.status(), WL_CONNECTED);
 
   MqttBroker broker(1883);
@@ -197,9 +428,9 @@ test(network_client_to_broker_connexion)
   assertTrue(client.connected());
 }
 
-test(network_one_client_one_broker_publish_and_subscribe_through_network)
+test(one_client_one_broker_publish_and_subscribe)
 {
-  start_servers(2, true);
+  start_many_wifi_esp(2, true);
   published.clear();
   assertEqual(WiFi.status(), WL_CONNECTED);
 
@@ -228,9 +459,9 @@ test(network_one_client_one_broker_publish_and_subscribe_through_network)
   assertEqual((int)lastLength, (int)2); // sizeof(ab)
 }
 
-test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
+test(one_client_one_broker_hudge_payload)
 {
-  start_servers(2, true);
+  start_many_wifi_esp(2, true);
   published.clear();
   assertEqual(WiFi.status(), WL_CONNECTED);
 
@@ -247,8 +478,8 @@ test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
 
   std::string sent;
 
-  for(int i=0; i<200; i++)
+  for(int i=0; i<400; i++)
-    sent += char('0'+i%10);
+    sent += char('a'+i%26);
 
   client.setCallback(onPublish);
   client.subscribe("a/b");
@@ -264,7 +495,7 @@ test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
   assertEqual((unsigned int)lastLength, (unsigned int)sent.size());
 }
 
-test(network_client_should_unregister_when_destroyed)
+test(client_should_unregister_when_destroyed)
 {
   assertEqual(broker.clientsCount(), (size_t)0);
   {
@@ -278,7 +509,7 @@ test(network_client_should_unregister_when_destroyed)
 // THESE TESTS ARE IN LOCAL MODE
 // WE HAVE TO CONVERT THEM TO WIFI MODE (pass through virtual TCP link)
 
-test(network_connect)
+test(connect)
 {
   assertEqual(broker.clientsCount(), (size_t)0);
 
@@ -287,7 +518,7 @@ test(network_connect)
   assertEqual(broker.clientsCount(), (size_t)1);
 }
 
-test(network_publish_should_be_dispatched)
+test(publish_should_be_dispatched)
 {
   published.clear();
   assertEqual(broker.clientsCount(), (size_t)0);
@@ -307,7 +538,7 @@ test(network_publish_should_be_dispatched)
   assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/c"], 2);
 }
 
-test(network_publish_should_be_dispatched_to_clients)
+test(publish_should_be_dispatched_to_clients)
 {
   published.clear();
   assertEqual(broker.clientsCount(), (size_t)0);
@@ -332,7 +563,7 @@ test(network_publish_should_be_dispatched_to_clients)
   assertEqual(published["B"]["a/c"], 0);
 }
 
-test(network_unsubscribe)
+test(unsubscribe)
 {
   published.clear();
   assertEqual(broker.clientsCount(), (size_t)0);
@@ -352,7 +583,7 @@ test(network_unsubscribe)
   assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/b"], 1);  // Only one publish has been received
 }
 
-test(network_nocallback_when_destroyed)
+test(nocallback_when_destroyed)
 {
   published.clear();
   assertEqual(broker.clientsCount(), (size_t)0);
@@ -371,7 +602,7 @@ test(network_nocallback_when_destroyed)
   assertEqual(published.size(), (size_t)1);  // Only one publish has been received
 }
 
-test(network_small_payload)
+test(small_payload)
 {
   published.clear();
 
@@ -389,7 +620,7 @@ test(network_small_payload)
   assertEqual(lastLength, (size_t)4);
 }
 
-test(network_hudge_payload)
+test(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 !";
 
@@ -436,7 +667,7 @@ test(connack)
     }
   );
 
-  start_servers(2, true);
+  start_many_wifi_esp(2, true);
   assertEqual(WiFi.status(), WL_CONNECTED);
 
   MqttBroker broker(1883);
@@ -469,7 +700,7 @@ void setup() {
   while(!Serial);
   */
 
-  Serial.println("=============[ FAKE NETWORK TinyMqtt TESTS       ]========================");
+  Serial.println("=============[ NETWORK TinyMqtt TESTS       ]========================");
 
   WiFi.mode(WIFI_STA);
   WiFi.begin("network", "password");