Merge branch 'main' into timeout

More informative error on version mismatch

.github/workflows/aunit.yml

@@ -20,7 +20,7 @@ jobs:
         git clone https://github.com/hsaturn/TinyConsole
         git clone https://github.com/hsaturn/EpoxyDuino
         git clone https://github.com/bxparks/AceRoutine
-        git clone https://github.com/bxparks/AUnit
+        git clone https://github.com/hsaturn/AUnit
         git clone https://github.com/bxparks/AceCommon
         git clone https://github.com/hsaturn/EspMock
     - name: Verify tests

README.md

@@ -10,8 +10,22 @@
 
 TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32 / Esp WROOM
 
+### Statuses of all unit tests of TinyMqtt and its dependencies
+
+| Project     | Unit tests result |
+| ----------- | ------------ |
+| TinyMqtt    | [![](https://github.com/hsaturn/TinyMqtt/actions/workflows/aunit.yml/badge.svg)](https://github.com/hsaturn/TinyMqtt/actions/workflows/aunit.yml) |
+| Dependencies                  ||
+| TinyConsole | [![](https://github.com/hsaturn/TinyConsole/actions/workflows/aunit.yml/badge.svg)](https://github.com/hsaturn/TinyConsole/actions/workflows/aunit.yml) |
+| EpoxyDuino  | [![AUnit Tests](https://github.com/hsaturn/EpoxyDuino/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/hsaturn/EpoxyDuino/actions/workflows/aunit_tests.yml) |
+| EspMock     | [![AUnit Tests](https://github.com/hsaturn/EspMock/actions/workflows/aunit.yml/badge.svg)](https://github.com/hsaturn/EspMock/actions/workflows/aunit.yml) |
+| AUnit | [![AUnit Tests](https://github.com/hsaturn/AUnit/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/hsaturn/AUnit/actions/workflows/aunit_tests.yml) |
+| AceRoutine | [![AUnit Tests](https://github.com/bxparks/AceRoutine/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/bxparks/AceRoutine/actions/workflows/aunit_tests.yml) |
+
 ## 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)
@@ -51,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,61 @@
+#!/bin/bash
+current_version=$(git describe --tags --abbrev=0)
+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
+	echo "Current version: ($current_version)"
+	echo "New version    : ($1)"
+	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
+
+      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 tag $1
+        git add library.properties
+        git add library.json
+        git commit -m "Release $1 $2"
+        git push
+        git push --tags
+      fi
+		else
+			echo "Current version does not match library.property version, aborting"
+		fi
+	fi
+fi

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

@@ -3,12 +3,12 @@
 #include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
 #include <TinyStreaming.h>
 #if defined(ESP8266)
-  #include <ESP8266mDNS.h>
+#include <ESP8266mDNS.h>
 #elif defined(ESP32)
-  #include <WiFi.h>
+#include <WiFi.h>
-  #include <ESPmDNS.h>
+#include <ESPmDNS.h>
 #else
-  #error Unsupported platform
+#error Unsupported platform
 #endif
 
 #include <sstream>
@@ -26,23 +26,25 @@ 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
 {
-  public:
+public:
-    free_broker(const char* s, uint16_t p, const char* comment) : url(s), port(p) {}
+  free_broker(const char *s, uint16_t p, const char * /* comment */) : url(s), port(p) {}
 
-    std::string url;
+  string url;
   uint16_t port;
 };
 
-const std::map<std::string, free_broker> list =
+const std::map<string, free_broker> list =
-{
+    {
-  { "mqtthq", { "public.mqtthq.com" , 8083, "publish/subscribe" }},
+        {"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,
@@ -55,16 +57,16 @@ const std::map<std::string, free_broker> list =
  * TODO examples of scripts
  */
 
-void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
+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--)
+    while (length--)
     {
-      const char c=*payload++;
+      const char c = *payload++;
-      if (c<32)
+      if (c < 32)
         Console << '?';
       else
         Console << c;
@@ -73,8 +75,8 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
   }
 }
 
-std::map<std::string, MqttClient*> clients;
+std::map<string, MqttClient *> clients;
-std::map<std::string, MqttBroker*> brokers;
+std::map<string, MqttBroker *> brokers;
 
 void setup()
 {
@@ -86,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;
@@ -94,10 +97,11 @@ void setup()
   Console << "*  Enter help to view the list of commands." << endl;
   Console << "***************************************************************" << endl;
   Console << endl;
-  if (strlen(ssid)==0)
+  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 << "' ";
 
@@ -107,215 +111,234 @@ 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";
+  const char *name = "tinytest";
   Console << "Starting MDNS, name= " << name;
   if (!MDNS.begin(name))
     Console << "  error, not available." << endl;
   else
     Console << " ok." << endl;
 
-
+  MqttBroker *broker = new MqttBroker(1883);
-  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();
 }
 
-std::string getword(std::string& str, const char* if_empty=nullptr, char sep=' ');
+string getword(string &str, const char *if_empty = nullptr, char sep = ' ');
 
-int getint(std::string& str, const int if_empty=0)
+int getint(string &str, const int if_empty = 0)
 {
-  std::string str2=str;
+  string str2 = str;
-  std::string sword = getword(str);
+  string sword = getword(str);
   if (sword[0] and isdigit(sword[0]))
   {
-    int ret=atoi(sword.c_str());
+    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;
+  str = str2;
   return if_empty;
 }
 
-std::string getword(std::string& str, const char* if_empty/*=nullptr*/, char sep/*=' '*/)
+string getword(string &str, const char *if_empty /*=nullptr*/, char sep /*=' '*/)
 {
-  char quote=(str[0]=='"' or str[0]=='\'' ? str[0] : 0);
+  char quote = (str[0] == '"' or str[0] == '\'' ? str[0] : 0);
-  if (quote) str.erase(0,1);
+  if (quote)
-  std::string sword;
+    str.erase(0, 1);
-  while(str.length() and (str[0]!=sep or quote))
+  string sword;
+  while (str.length() and (str[0] != sep or quote))
   {
-    if (str[0]==quote)
+    if (str[0] == quote)
     {
-      str.erase(0,1);
+      str.erase(0, 1);
       break;
     }
     sword += str[0];
-    str.erase(0,1);
+    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 (quote==false and sword.length()>=4 and sword.substr(0,3)=="rnd")
+  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);
+    sword.erase(0, 3);
-    if (sword[0]=='(')
+    if (sword[0] == '(')
     {
       int to = 100;
-      sword.erase(0,1);
+      sword.erase(0, 1);
-      int from=getint(sword);
+      int from = getint(sword);
-      if (sword[0]==',')
+      if (sword[0] == ',')
       {
-        sword.erase(0,1);
+        sword.erase(0, 1);
         to = getint(sword);
-        if (sword[0]!=')') Console << "Missing ')'" << endl;
+        if (sword[0] != ')')
+          Console << "Missing ')'" << endl;
       }
       else
       {
-        to=from;
+        to = from;
-        from=0;
+        from = 0;
       }
-      return String(random(from,to)).c_str();
+      return String(random(from, to)).c_str();
     }
     else
     {
       Console << "Missing '('" << endl;
     }
   }
-  while(str[0]==' ') str.erase(0,1);
+  while (str[0] == ' ')
+    str.erase(0, 1);
   return sword;
 }
 
-bool isaddr(std::string s)
+bool isaddr(string s)
 {
-  if (s.length()==0 or s.length()>3) return false;
+  if (s.length() == 0 or s.length() > 3)
-  for(char c: s)
+    return false;
-    if (c<'0' or c>'9') return false;
+  for (char c : s)
+    if (c < '0' or c > '9')
+      return false;
   return true;
 }
 
-std::string getip(std::string& str, const char* if_empty=nullptr, char sep=' ')
+string getip(string &str, const char *if_empty = nullptr, char sep = ' ')
 {
-  std::string addr=getword(str, if_empty, sep);
+  string addr = getword(str, if_empty, sep);
-  std::string ip=addr;
+  string ip = addr;
-  std::vector<std::string> build;
+  std::vector<string> build;
-  while(ip.length())
+  while (ip.length())
   {
-    std::string b=getword(ip,nullptr,'.');
+    string b = getword(ip, nullptr, '.');
-    if (isaddr(b) && build.size()<4)
+    if (isaddr(b) && build.size() < 4)
     {
       build.push_back(b);
     }
     else
       return addr;
   }
-  IPAddress local=WiFi.localIP();
+  IPAddress local = WiFi.localIP();
   addr.clear();
-  while(build.size()!=4)
+  while (build.size() != 4)
   {
     std::stringstream b;
-    b << (int)local[3-build.size()];
+    b << (int)local[3 - build.size()];
-    build.insert(build.begin(), b.str());
+    build.insert(build.begin(), b.str().c_str());
   }
-  for(std::string s: build)
+  for (string s : build)
   {
-    if (addr.length()) addr += '.';
+    if (addr.length())
+      addr += '.';
     addr += s;
   }
   Console << "connect address: " << addr << endl;
   return addr;
 }
 
-std::map<std::string, std::string> vars;
+std::map<string, string> vars;
 
-std::set<std::string> commands = {
+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(std::string& search)
+void convertToCommand(string &search)
 {
-  while(search[0]==' ') search.erase(0,1);
+  while (search[0] == ' ')
-  if (search.length()==0) return;
+    search.erase(0, 1);
-  std::string matches;
+  if (search.length() == 0)
-  int count=0;
+    return;
-  for(std::string cmd: commands)
+  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;
     }
   }
-  if (count==1)
+  if (count == 1)
     search = matches;
-  else if (count>1)
+  else if (count > 1)
   {
     Console << "Ambiguous command: " << matches << endl;
     search.clear();
   }
 }
 
-void replace(const char* d, std::string& str, std::string srch, std::string to)
+void replace(const char *d, string &str, string srch, string to)
 {
   if (d[0] && d[1])
   {
-    srch=d[0]+srch+d[1];
+    srch = d[0] + srch + d[1];
-    to=d[0]+to+d[1];
+    to = d[0] + to + d[1];
 
     size_t pos = 0;
-    while((pos=str.find(srch, pos)) != std::string::npos)
+    while ((pos = str.find(srch, pos)) != string::npos)
     {
       str.erase(pos, srch.length());
       str.insert(pos, to);
-      pos += to.length()-1;
+      pos += to.length() - 1;
     }
   }
 }
 
-void replaceVars(std::string& cmd)
+void replaceVars(string &cmd)
 {
-  cmd = ' '+cmd+' ';
+  cmd = ' ' + cmd + ' ';
 
-  for(auto it: vars)
+  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(0, cmd.find_first_not_of(' '));
-  cmd.erase(cmd.find_last_not_of(" ")+1);
+  cmd.erase(cmd.find_last_not_of(' ') + 1);
-
 }
 
-bool compare(std::string s, const char* cmd)
+bool compare(string s, const char *cmd)
 {
-  uint8_t p=0;
+  uint8_t p = 0;
-  while(s[p++]==*cmd++)
+  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;
 }
 
-using ClientFunction = void(*)(std::string& cmd, MqttClient* publish);
+using ClientFunction = void (*)(string &cmd, MqttClient *publish);
 
 struct Every
 {
-  std::string cmd;
+  string cmd;
   uint32_t ms;
   uint32_t next;
-  uint32_t underrun=0;
+  uint32_t underrun = 0;
-  bool active=true;
+  bool active = true;
 
   void dump()
   {
@@ -324,12 +347,12 @@ struct Every
     else
       Console << red << "disabled";
 
-    auto mill=millis();
+    auto mill = millis();
     Console << white << ms << "ms [" << cmd << "] next in ";
     if (mill > next)
       Console << "now";
     else
-      Console << next-mill << "ms";
+      Console << next - mill << "ms";
   }
 };
 
@@ -341,49 +364,49 @@ int16_t blink;
 
 std::vector<Every> everies;
 
-void onCommand(const std::string& command)
+void onCommand(const string &command)
 {
   Console << endl;
-  std::string cmd=command;
+  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, std::string& cmd)
+void clientConnect(MqttClient *client, string &cmd)
 {
-  std::string remote = getword(cmd);
+  string remote = getword(cmd);
   uint16_t port;
-  auto it=list.find(remote);
+  auto it = list.find(remote);
   if (it != list.end())
   {
     Console << "Connecting to free broker: " << remote << endl;
     remote = it->second.url;
-    port=it->second.port;
+    port = it->second.port;
   }
   else
-    port=getint(cmd);
+    port = getint(cmd);
 
   client->connect(remote.c_str(), port, getint(cmd, 60));
   Console << (client->connected() ? "connected." : "not connected") << endl;
 }
 
-void eval(std::string& cmd)
+void eval(string &cmd)
 {
-  while(cmd.length())
+  while (cmd.length())
   {
     MqttError retval = MqttOk;
 
-    std::string s;
+    string s;
-    MqttBroker* broker = nullptr;
+    MqttBroker *broker = nullptr;
-    MqttClient* client = nullptr;
+    MqttClient *client = nullptr;
 
     // client.function notation
-    if (cmd.find('.') != std::string::npos &&
+    if (cmd.find('.') != string::npos &&
         cmd.find('.') < cmd.find(' '))
     {
-      s=getword(cmd, nullptr, '.');
+      s = getword(cmd, nullptr, '.');
 
       if (s.length())
       {
@@ -404,9 +427,11 @@ void eval(std::string& cmd)
     }
 
     s = getword(cmd);
-    if (s.length()) convertToCommand(s);
+    if (s.length())
-    if (s.length()==0)
+      convertToCommand(s);
-    {}
+    if (s.length() == 0)
+    {
+    }
     else if (compare(s, "debug"))
     {
 #if TINY_MQTT_DEBUG
@@ -418,14 +443,14 @@ void eval(std::string& cmd)
     else if (compare(s, "list"))
     {
       Console << "List of free servers" << endl;
-      for(const auto& fb: list)
+      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)
+      if (client == nullptr && broker == nullptr)
       {
         s = getword(cmd);
         if (clients.find(s) != clients.end())
@@ -441,9 +466,10 @@ void eval(std::string& cmd)
       }
       if (client)
       {
-        for (auto it: clients)
+        for (auto it : clients)
         {
-          if (it.second != client) continue;
+          if (it.second != client)
+            continue;
           Console << "deleted" << endl;
           delete (it.second);
           clients.erase(it.first);
@@ -453,9 +479,10 @@ void eval(std::string& cmd)
       }
       else if (broker)
       {
-        for(auto it: brokers)
+        for (auto it : brokers)
         {
-          if (broker != it.second) continue;
+          if (broker != it.second)
+            continue;
           Console << "deleted" << endl;
           delete (it.second);
           brokers.erase(it.first);
@@ -468,7 +495,7 @@ void eval(std::string& cmd)
     }
     else if (broker)
     {
-      if (compare(s,"connect"))
+      if (compare(s, "connect"))
       {
         Console << "NYI" << endl;
       }
@@ -484,15 +511,15 @@ void eval(std::string& cmd)
     }
     else if (client)
     {
-      if (compare(s,"connect"))
+      if (compare(s, "connect"))
       {
         clientConnect(client, cmd);
       }
-      else if (compare(s,"publish"))
+      else if (compare(s, "publish"))
       {
         retval = client->publish(getword(cmd), getword(cmd));
       }
-      else if (compare(s,"subscribe"))
+      else if (compare(s, "subscribe"))
       {
         client->subscribe(getword(cmd));
       }
@@ -512,27 +539,27 @@ void eval(std::string& cmd)
     }
     else if (compare(s, "on"))
     {
-      uint8_t pin=getint(cmd, 2);
+      uint8_t pin = getint(cmd, 2);
       pinMode(pin, OUTPUT);
       digitalWrite(pin, HIGH);
     }
     else if (compare(s, "off"))
     {
-      uint8_t pin=getint(cmd, 2);
+      uint8_t pin = getint(cmd, 2);
       pinMode(pin, OUTPUT);
       digitalWrite(pin, LOW);
     }
     else if (compare(s, "echo"))
     {
-      s=getword(cmd);
+      s = getword(cmd);
-      if (s=="on")
+      if (s == "on")
         echo_on = true;
-      else if (s=="off")
+      else if (s == "off")
         echo_on = false;
       else
       {
         Console << s << ' ';
-        while(cmd.length())
+        while (cmd.length())
         {
           Console << getword(cmd) << ' ';
         }
@@ -546,9 +573,9 @@ void eval(std::string& cmd)
         if (cmd.length())
         {
           Every every;
-          every.ms=ms;
+          every.ms = ms;
-          every.cmd=cmd;
+          every.cmd = cmd;
-          every.next=millis()+ms;
+          every.next = millis() + ms;
           everies.push_back(every);
           every.dump();
           Console << endl;
@@ -557,16 +584,16 @@ void eval(std::string& cmd)
       }
       else if (compare(cmd, "off") or compare(cmd, "on"))
       {
-        bool active=getword(cmd)=="on";
+        bool active = getword(cmd) == "on";
-        uint8_t ever=getint(cmd, 100);
+        uint8_t ever = getint(cmd, 100);
-        uint8_t count=0;
+        uint8_t count = 0;
-        for(auto& every: everies)
+        for (auto &every : everies)
         {
-          if (count==ever or (ever==100))
+          if (count == ever or (ever == 100))
           {
             if (every.active != active)
             {
-              Console << "every #" << count << (active ? " on" :" off") << endl;
+              Console << "every #" << count << (active ? " on" : " off") << endl;
               every.active = active;
               every.underrun = 0;
             }
@@ -574,12 +601,12 @@ void eval(std::string& cmd)
           count++;
         }
       }
-      else if (compare(cmd, "list") or cmd.length()==0)
+      else if (compare(cmd, "list") or cmd.length() == 0)
       {
         getword(cmd);
         Console << "List of everies (ms=" << millis() << ")" << endl;
-        uint8_t count=0;
+        uint8_t count = 0;
-        for(auto& every: everies)
+        for (auto &every : everies)
         {
           Console << count << ": ";
           every.dump();
@@ -591,20 +618,20 @@ void eval(std::string& cmd)
       {
         Console << "Removing..." << endl;
         getword(cmd);
-        int8_t every=getint(cmd, -1);
+        int8_t every = getint(cmd, -1);
-        if (every==-1 and compare(cmd, "last") and everies.size())
+        if (every == -1 and compare(cmd, "last") and everies.size())
         {
           getword(cmd);
-          everies.erase(everies.begin()+everies.size()-1);
+          everies.erase(everies.begin() + everies.size() - 1);
         }
-        else if (every==-1 and compare(cmd, "all"))
+        else if (every == -1 and compare(cmd, "all"))
         {
           getword(cmd);
           everies.clear();
         }
         else if (everies.size() > (uint8_t)every)
         {
-          everies.erase(everies.begin()+every);
+          everies.erase(everies.begin() + every);
         }
         else
           Console << "Bad colmmand" << endl;
@@ -617,33 +644,33 @@ void eval(std::string& cmd)
       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_on[blink_nr] = getint(cmd, blink_ms_on[blink_nr]);
-        blink_ms_off[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;
+          blink |= 1 << blink_nr;
         else
         {
-          blink &= ~(1<< blink_nr);
+          blink &= ~(1 << blink_nr);
         }
       }
     }
     else if (compare(s, "broker"))
     {
-      std::string id=getword(cmd);
+      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())
+      else if (id.length() or brokers.find(id) != brokers.end())
       {
-        int port=getint(cmd, 0);
+        int port = getint(cmd, 0);
         if (port)
         {
-          MqttBroker* broker = new MqttBroker(port);
+          MqttBroker *broker = new MqttBroker(port);
           broker->begin();
 
           brokers[id] = broker;
@@ -663,25 +690,26 @@ void eval(std::string& cmd)
     }
     else if (compare(s, "client"))
     {
-      std::string id=getword(cmd);
+      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())
+      else if (id.length() or clients.find(id) != clients.end())
       {
-        s=getword(cmd);  // broker
+        s = getword(cmd); // broker
-        if (s=="" or brokers.find(s) != brokers.end() or list.find(s) != list.end())
+        if (s == "" or brokers.find(s) != brokers.end() or list.find(s) != list.end())
         {
-          MqttBroker* broker = nullptr;
+          MqttBroker *broker = nullptr;
-          if (s.length()) broker = brokers[s];
+          if (s.length())
-          MqttClient* client = new MqttClient(broker, id);
+            broker = brokers[s];
-          clients[id]=client;
+          MqttClient *client = new MqttClient(broker, id);
+          clients[id] = client;
           client->setCallback(onPublish);
           if (list.find(s) != list.end())
           {
-            cmd=s+' '+cmd;
+            cmd = s + ' ' + cmd;
             clientConnect(client, cmd);
           }
           Console << "new client (" << id.c_str() << ", " << s.c_str() << ')' << endl;
@@ -700,10 +728,10 @@ void eval(std::string& cmd)
     }
     else if (compare(s, "set"))
     {
-      std::string name(getword(cmd));
+      string name(getword(cmd));
-      if (name.length()==0)
+      if (name.length() == 0)
       {
-        for(auto it: vars)
+        for (auto it : vars)
         {
           Console << "  " << it.first << " -> " << it.second << endl;
         }
@@ -730,18 +758,18 @@ void eval(std::string& cmd)
       if (view)
       {
         Console << save_cursor << magenta;
-        Console.gotoxy(1,1);
+        Console.gotoxy(1, 1);
       }
       Console << "--< " << '/' << clients.size() << " client/s. >--" << erase_to_end << endl;
-      for(auto it: clients)
+      for (auto it : clients)
       {
         it.second->dump("  ");
       }
 
       Console << "--< " << brokers.size() << " brokers/s. >--" << erase_to_end << endl;
-      for(auto it: brokers)
+      for (auto it : brokers)
       {
-        Console << "  +-- '" << it.first.c_str() << "' " << it.second->clientsCount() << " client/s."<< erase_to_end << endl;
+        Console << "  +-- '" << it.first.c_str() << "' " << it.second->clientsCount() << " client/s." << erase_to_end << endl;
         it.second->dump("     ");
       }
       if (view)
@@ -754,7 +782,7 @@ void eval(std::string& cmd)
       ESP.restart();
     else if (compare(s, "ip"))
       Console << "IP: " << WiFi.localIP() << endl;
-    else if (compare(s,"help"))
+    else if (compare(s, "help"))
     {
       Console << "syntax:" << endl;
       Console << "  MqttBroker:" << endl;
@@ -788,7 +816,8 @@ void eval(std::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;
     }
@@ -802,30 +831,32 @@ void eval(std::string& cmd)
 
 void loop()
 {
-  auto ms=millis();
+  auto ms = millis();
-  int8_t out=0;
+  int8_t out = 0;
   int16_t blink_bits = blink;
-  uint8_t e=0;
+  uint8_t e = 0;
 
-  for(auto& every: everies)
+  for (auto &every : everies)
   {
-    if (not every.active) continue;
+    if (not every.active)
+      continue;
     if (every.ms && every.cmd.length() && ms > every.next)
     {
-      std::string cmd(every.cmd);
+      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;
+        Console.fg(white);
+        every.underrun = ms + 5000;
       }
     }
     e++;
   }
 
-  while(blink_bits)
+  while (blink_bits)
   {
     if (blink_ms_on[out] and ms > blink_next[out])
     {
@@ -841,19 +872,18 @@ void loop()
       }
       blink_state[out] = not blink_state[out];
     }
-    blink_bits >>=1;
+    blink_bits >>= 1;
     out++;
   }
 
-  static long count;
 #if defined(ESP9266)
   MDNS.update();
 #endif
 
-  for(auto it: brokers)
+  for (auto it : brokers)
     it.second->loop();
 
-  for(auto it: clients)
+  for (auto it : clients)
     it.second->loop();
 
   Console.loop();

library.json

@@ -0,0 +1,20 @@
+{
+    "name": "TinyMqtt",
+    "keywords": "ethernet, mqtt, m2m, iot",
+    "description": "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",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/hsaturn/TinyMqtt.git"
+    },
+    "dependencies":
+    { "hsaturn/TinyConsole" : "*" },
+    "version": "0.9.19",
+    "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.11
+version=0.9.19
 author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
-maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
+maintainer=Francois BIOT <hsaturn@gmail.com>
 sentence=A tiny broker and client library for MQTT messaging.
-paragraph=MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive MQTT messages and to host a broker in your ESP 8266 and 32 WROOM. It does support MQTT 3.1.1 with QoS=0.
+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).
 category=Communication
 url=https://github.com/hsaturn/TinyMqtt
 architectures=*
-depends=TinyConsole
+depends=hsaturn/TinyConsole
 includes=TinyMqtt.h

src/StringIndexer.cpp

@@ -1,3 +1,4 @@
 #include "StringIndexer.h"
 
-std::map<StringIndexer::index_t, StringIndexer::StringCounter> StringIndexer::strings;
+StringIndexer::Strings StringIndexer::strings;
+

src/StringIndexer.h

@@ -1,18 +1,25 @@
 // vim: ts=2 sw=2 expandtab
 #pragma once
+#include <assert.h>
 #include <map>
+#include <unordered_map>
+#include "TinyConsole.h"
 #include <string>
 #include <string.h>
 
+using string = TinyConsole::string;
+
 /***
  * Allows to store up to 255 different strings with one byte class
  * very memory efficient when one string is used many times.
  */
 class StringIndexer
 {
+  private:
+
   class StringCounter
   {
-    std::string str;
+    string str;
     uint8_t used=0;
     friend class StringIndexer;
 
@@ -29,9 +36,9 @@ class StringIndexer
   public:
     using index_t = uint8_t;
 
-   static const std::string& str(const index_t& index)
+   static const string& str(const index_t& index)
    {
-      static std::string dummy;
+     static string dummy;
      const auto& it=strings.find(index);
      if (it == strings.end()) return dummy;
      return it->second.str;
@@ -77,7 +84,7 @@ class StringIndexer
       {
         if (strings.find(index)==strings.end())
         {
-          strings[index].str = std::string(str, len);
+          strings[index].str = string(str, len);
           strings[index].used++;
           // Serial << "Creating index " << index << " for (" << strings[index].str.c_str() << ") len=" << len << endl;
           return index;
@@ -86,7 +93,9 @@ class StringIndexer
       return 0;  // TODO out of indexes
     }
 
-    static std::map<index_t, StringCounter> strings;
+    using Strings = std::unordered_map<index_t, StringCounter>;
+
+    static Strings strings;
 };
 
 class IndexedString
@@ -98,12 +107,14 @@ class IndexedString
       index = source.index;
     }
 
+    IndexedString(IndexedString&& i) : index(i.index) {}
+
     IndexedString(const char* str, uint8_t len)
     {
       index=StringIndexer::strToIndex(str, len);
     }
 
-    IndexedString(const std::string& str) : IndexedString(str.c_str(), str.length()) {};
+    IndexedString(const string& str) : IndexedString(str.c_str(), str.length()) {};
 
     ~IndexedString() { StringIndexer::release(index); }
 
@@ -124,7 +135,7 @@ class IndexedString
       return i1.index == i2.index;
     }
 
-    const std::string& str() const { return StringIndexer::str(index); }
+    const string& str() const { return StringIndexer::str(index); }
 
     const StringIndexer::index_t& getIndex() const { return index; }
 

src/TinyMqtt.cpp

@@ -15,9 +15,11 @@ int TinyMqtt::debug=2;
   std::map<MqttMessage::Type, int> MqttClient::counters;
 #endif
 
-MqttBroker::MqttBroker(uint16_t port)
+MqttBroker::MqttBroker(uint16_t port, uint8_t max_retain_size)
 {
-  server.reset(new TcpServer(port));
+  debug("New broker" << port);
+  retain_size = max_retain_size;
+  server = new TcpServer(port);
 #ifdef TINY_MQTT_ASYNC
   server->onClient(onClient, this);
 #endif
@@ -27,31 +29,41 @@ MqttBroker::~MqttBroker()
 {
   while(clients.size())
   {
-    delete clients[0];
+    auto client = clients[0];
+    client->local_broker = nullptr;
+    if (client->cltFlags & MqttClient::CltFlags::CltFlagToDelete)
+    {
+      // std::cout << "Deleting client" << std::endl;
+      delete client;
     }
+    clients.erase(clients.begin());
+  }
+  delete server;
 }
 
 // private constructor used by broker only
 MqttClient::MqttClient(MqttBroker* local_broker, TcpClient* new_client)
+  : local_broker(local_broker)
 {
-  dclass;
-  connect(local_broker);
   debug("MqttClient private with broker");
 #ifdef TINY_MQTT_ASYNC
-  tcp_client.reset(new_client);
+  tcp_client = new_client;
   tcp_client->onData(onData, this);
   // client->onConnect() TODO
   // client->onDisconnect() TODO
 #else
-  tcp_client.reset(new WiFiClient(*new_client));
+  tcp_client = new WiFiClient(*new_client);
+#endif
+#ifdef EPOXY_DUINO
+  alive = millis()+500000;
+#else
+  alive = millis()+5000;  // TODO MAGIC client expires after 5s if no CONNECT msg
 #endif
-  alive = millis()+5000;
 }
 
-MqttClient::MqttClient(MqttBroker* local_broker, const std::string& id)
+MqttClient::MqttClient(MqttBroker* local_broker, const string& id)
   : local_broker(local_broker), clientId(id)
 {
-  dclass;
   alive = 0;
   keep_alive = 0;
 
@@ -60,15 +72,15 @@ MqttClient::MqttClient(MqttBroker* local_broker, const std::string& id)
 
 MqttClient::~MqttClient()
 {
-  dtor;
   close();
+  delete tcp_client;
   debug("*** MqttClient delete()");
 }
 
 void MqttClient::close(bool bSendDisconnect)
 {
   debug("close " << id().c_str());
-  mqtt_flags &= ~FlagConnected;
+  resetFlag(CltFlagConnected);
   if (tcp_client)  // connected to a remote broker
   {
     if (bSendDisconnect and tcp_client->connected())
@@ -90,28 +102,28 @@ void MqttClient::close(bool bSendDisconnect)
 void MqttClient::connect(MqttBroker* local)
 {
   debug("MqttClient::connect_local");
-  alive = 0;
   close();
   local_broker = local;
-  clientAlive();
+  local_broker->addClient(this);
 }
 
-void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
+void MqttClient::connect(string broker, uint16_t port, uint16_t ka)
 {
   debug("MqttClient::connect_to_host " << broker << ':' << port);
   keep_alive = ka;
   close();
-  tcp_client.reset(new TcpClient);
+  if (tcp_client) delete tcp_client;
+  tcp_client = new TcpClient;
 
 #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))
   {
     debug("link established");
-    onConnect(this, tcp_client.get());
+    onConnect(this, tcp_client);
   }
   else
   {
@@ -120,23 +132,41 @@ void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
 #endif
 }
 
-void MqttBroker::connect(const std::string& host, uint16_t port)
+void MqttBroker::addClient(MqttClient* client)
+{
+  debug("MqttBroker::addClient");
+  clients.push_back(client);
+}
+
+void MqttBroker::connect(const string& host, uint16_t port)
 {
   debug("MqttBroker::connect");
   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)
 {
-  local_clients.erase(remove);
+  debug("removeClient");
-  for(auto it = clients.begin(); it!=clients.end(); it++)
+  for(auto it=clients.begin(); it!=clients.end(); it++)
-    if (*it == remove)
   {
+    auto client=*it;
+    if (client==remove)
+    {
+      // TODO if this broker is connected to an external broker
+      // we have to unsubscribe remove's topics.
+      // (but doing this, check that other clients are not subscribed...)
+      // Unless -> we could receive useless messages
+      //        -> we are using (memory) one IndexedString plus its string for nothing.
+      debug("Remove " << clients.size());
       clients.erase(it);
-      break;
+      debug("Client removed " << clients.size());
+      return;
     }
+  }
+  debug(red << "Error cannot remove client");  // TODO should not occur
 }
 
 void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
@@ -144,15 +174,16 @@ void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
   debug("MqttBroker::onClient");
   MqttBroker* broker = static_cast<MqttBroker*>(broker_ptr);
 
-  broker->clients.push_back(new MqttClient(broker, client));
+  MqttClient* mqtt = new MqttClient(broker, client);
+  mqtt->setFlag(MqttClient::CltFlags::CltFlagToDelete);
+  broker->addClient(mqtt);
   debug("New client");
 }
 
 void MqttBroker::loop()
 {
 #ifndef TINY_MQTT_ASYNC
-  if (not server) return;
+  WiFiClient client = server->accept();
-  WiFiClient client = server->available();
 
   if (client)
   {
@@ -166,12 +197,9 @@ void MqttBroker::loop()
     remote_broker->loop();
   }
 
-  // keep track on size because loop can remove a client from containers
+  for(size_t i=0; i<clients.size(); i++)
-  // loop on remote clients (connected through network)
-  auto size = clients.size();
-  for(auto it = clients.begin(); it!=clients.end(); it++)
   {
-    MqttClient* client = *it;
+    MqttClient* client = clients[i];
     if (client->connected())
     {
       client->loop();
@@ -180,22 +208,25 @@ void MqttBroker::loop()
     {
       debug("Client " << client->id().c_str() << "  Disconnected, local_broker=" << (dbg_ptr)client->local_broker);
       // Note: deleting a client not added by the broker itself will probably crash later.
+      delete client;
+      break;
     }
-    if (size != clients.size()) break;
-  }
-
-  // loop on local clients (on same device as the broker's)
-  size = local_clients.size();
-  for(auto& client: local_clients)
-  {
-    client->loop();
-    if (local_clients.size() != size) break;
   }
 }
 
-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& [retained_topic, retain]: retained)
+  {
+    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);
@@ -203,31 +234,45 @@ 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;  // TODO here retval is badly computed
+  MqttError retval = MqttOk;
+
+  retain(topic, msg);
 
   debug("MqttBroker::publish");
-
+  int i=0;
-  if (remote_broker == nullptr or source == remote_broker)  // external broker -> internal clients
+  for(auto client: clients)
   {
-    for(auto& client: clients)
+    i++;
+#if TINY_MQTT_DEBUG
+    Console << __LINE__ << " broker:" << (remote_broker && remote_broker->connected() ? "linked" : "alone") <<
+       "  srce=" << (source->isLocal() ? "loc" : "rem") << " clt#" << i << ", local=" << client->isLocal() << ", con=" << client->connected() << endl;
+#endif
+    bool doit = false;
+    if (remote_broker && remote_broker->connected())  // this (MqttBroker) is connected (to a external broker)
     {
-      retval = client->publishIfSubscribed(topic, msg);
+      // ext_broker -> clients or clients -> ext_broker
-    }
+      if (source == remote_broker)  // external broker -> internal clients
-    for(auto& client: local_clients)
+        doit = true;
-    {
+      else                  // external clients -> this broker
-      retval = client->publishIfSubscribed(topic, msg);
-    }
-  }
-  else
-  {
-    if (remote_broker && remote_broker->connected())
       {
+        // As this broker is connected to another broker, simply forward the msg
         MqttError ret = remote_broker->publishIfSubscribed(topic, msg);
         if (ret != MqttOk) retval = ret;
       }
     }
+    else // Disconnected
+    {
+      doit = true;
+    }
+#if TINY_MQTT_DEBUG
+    Console << ", doit=" << doit << ' ';
+#endif
+
+    if (doit) retval = client->publishIfSubscribed(topic, msg);
+    debug("");
+  }
   return retval;
 }
 
@@ -247,12 +292,16 @@ void MqttMessage::getString(const char* &buff, uint16_t& len)
   buff+=2;
 }
 
-void MqttClient::clientAlive()
+void MqttClient::clientAlive(uint32_t more_seconds)
 {
   debug("MqttClient::clientAlive");
   if (keep_alive)
   {
-    alive=millis()+1000*(keep_alive+(local_broker ? TINY_MQTT_CLIENT_ALIVE_TOLERANCE : 0));
+#ifdef EPOXY_DUINO
+    alive=millis()+500000+0*more_seconds;
+#else
+    alive=millis()+1000*(keep_alive+more_seconds);
+#endif
   }
   else
     alive=0;
@@ -260,26 +309,26 @@ void MqttClient::clientAlive()
 
 void MqttClient::loop()
 {
-  if (keep_alive && (millis() >= alive))
+  if (keep_alive && (millis() >= alive - 5000))
   {
-    if (local_broker)
+    if (tcp_client && tcp_client->connected())
-    {
-      Serial << "timeout client " << clientId << endl;
-      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);
-
+      pingreq.sendTo(this);
-      tcp_client->write((const char*)(&pingreq), 2);
+      clientAlive(0);
-      clientAlive();
 
       // 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)
   {
@@ -310,7 +359,7 @@ void MqttClient::onConnect(void *mqttclient_ptr, TcpClient*)
   msg.reset();
   debug("cnx: mqtt sent " << (dbg_ptr)mqtt->local_broker);
 
-  mqtt->clientAlive();
+  mqtt->clientAlive(0);
 }
 
 #ifdef TINY_MQTT_ASYNC
@@ -358,13 +407,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;
 }
@@ -417,14 +466,13 @@ void MqttClient::processMessage(MqttMessage* mesg)
   switch(mesg->type())
   {
     case MqttMessage::Type::Connect:
-      if (mqtt_flags & FlagConnected)
+      if (mqtt_connected())
       {
         debug("already connected");
         break;
       }
       payload = header+10;
-      // Todo should check that reserved == 0 (spec)
+      mqtt_flags = header[7];
-      mqtt_flags = header[7] & ~FlagConnected;
       keep_alive = MqttMessage::getSize(header+8);
       if (strncmp("MQTT", header+2,4))
       {
@@ -433,13 +481,13 @@ void MqttClient::processMessage(MqttMessage* mesg)
       }
       if (header[6]!=0x04)
       {
-        debug("unknown level");
+        debug("Unsupported MQTT version (" << (int) header[6] << "), only version=4 supported" << endl);
         break;  // Level 3.1.1
       }
 
       // ClientId
       mesg->getString(payload, len);
-      clientId = std::string(payload, len);
+      clientId = string(payload, len);
       payload += len;
 
       if (mqtt_flags & FlagWill)  // Will topic
@@ -468,7 +516,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
         Console << yellow << "Client " << clientId << " connected : keep alive=" << keep_alive << '.' << white << endl;
       #endif
       bclose = false;
-      mqtt_flags |= FlagConnected;
+      setFlag(CltFlagConnected);
       {
         MqttMessage msg(MqttMessage::Type::ConnAck);
         msg.add(0);  // Session present (not implemented)
@@ -478,14 +526,14 @@ void MqttClient::processMessage(MqttMessage* mesg)
       break;
 
     case MqttMessage::Type::ConnAck:
-      mqtt_flags |= FlagConnected;
+      setFlag(CltFlagConnected);
       bclose = false;
       resubscribe();
       break;
 
     case MqttMessage::Type::SubAck:
     case MqttMessage::Type::PubAck:
-      if (not (mqtt_flags & FlagConnected)) break;
+      if (not mqtt_connected()) break;
       // Ignore acks
       bclose = false;
       break;
@@ -496,7 +544,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
       break;
 
     case MqttMessage::Type::PingReq:
-      if (not (mqtt_flags & FlagConnected)) break;
+      if (not mqtt_connected()) break;
       if (tcp_client)
       {
         uint16_t pingreq = MqttMessage::Type::PingResp;
@@ -513,15 +561,15 @@ void MqttClient::processMessage(MqttMessage* mesg)
     case MqttMessage::Type::Subscribe:
     case MqttMessage::Type::UnSubscribe:
       {
-        if (not (mqtt_flags & FlagConnected)) break;
+        if (not mqtt_connected()) break;
         payload = header+2;
 
         debug("un/subscribe loop");
-        std::string qoss;
+        string qoss;
         while(payload < mesg->end())
         {
           mesg->getString(payload, len);  // Topic
-          debug( "  topic (" << std::string(payload, len) << ')');
+          debug( "  topic (" << string(payload, len) << ')');
           // subscribe(Topic(payload, len));
           Topic topic(payload, len);
 
@@ -536,7 +584,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
             }
             else
               qoss.push_back(qos);
-            subscriptions.insert(topic);
+            subscribe(topic);
           }
           else
           {
@@ -557,15 +605,15 @@ void MqttClient::processMessage(MqttMessage* mesg)
       break;
 
     case MqttMessage::Type::UnSuback:
-      if (not (mqtt_flags & FlagConnected)) break;
+      if (not mqtt_connected()) break;
       bclose = false;
       break;
 
     case MqttMessage::Type::Publish:
       #if TINY_MQTT_DEBUG
-        Console << "publish " << (mqtt_flags & FlagConnected) << '/' << (long) tcp_client.get() << endl;
+        Console << "publish " << mqtt_connected() << '/' << (long) tcp_client << endl;
       #endif
-      if ((mqtt_flags & FlagConnected) or tcp_client == nullptr)
+      if (mqtt_connected() or tcp_client == nullptr)
       {
         uint8_t qos = mesg->flags();
         payload = header;
@@ -575,7 +623,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
         #if TINY_MQTT_DEBUG
           Console << "Received Publish (" << published.str().c_str() << ") size=" << (int)len << endl;
         #endif
-        // << '(' << std::string(payload, len).c_str() << ')'  << " msglen=" << mesg->length() << endl;
+        // << '(' << string(payload, len).c_str() << ')'  << " msglen=" << mesg->length() << endl;
         if (qos) payload+=2;  // ignore packet identifier if any
         len=mesg->end()-payload;
         // TODO reset DUP
@@ -586,13 +634,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
@@ -606,8 +654,8 @@ void MqttClient::processMessage(MqttMessage* mesg)
 
     case MqttMessage::Type::Disconnect:
       // TODO should discard any will msg
-      if (not (mqtt_flags & FlagConnected)) break;
+      if (not mqtt_connected()) break;
-      mqtt_flags &= ~FlagConnected;
+      resetFlag(CltFlagConnected);
       close(false);
       bclose=false;
       break;
@@ -628,7 +676,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
   }
   else
   {
-    clientAlive();
+    clientAlive(local_broker ? 5 : 0);
   }
 }
 
@@ -696,9 +744,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();
@@ -862,12 +910,41 @@ 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()));
+  if (retain_size==0 or msg.type() != MqttMessage::Publish) return;
+  if (msg.flags() & 1)  // flag RETAIN
+  {
+    debug("  retaining " << topic.str());
+    if (retained.find(topic) == retained.end()) retainDrop();
+    // FIXME if payload size == 0 remove message from retained
+    Retain r(micros(), msg);
+    retained.insert({ topic, std::move(r)});
+  }
+}
+
 void MqttMessage::hexdump(const char* prefix) const
 {
   (void)prefix;
 #if TINY_MQTT_DEBUG
   if (TinyMqtt::debug<2) return;
-  static std::map<Type, std::string> tts={
+  static std::map<Type, string> tts={
     { Connect, "Connect" },
     { ConnAck, "Connack" },
     { Publish, "Publish" },
@@ -880,7 +957,7 @@ void MqttMessage::hexdump(const char* prefix) const
     { PingResp, "Pingresp" },
     { Disconnect, "Disconnect" }
   };
-  std::string t("Unknown");
+  string t("Unknown");
   Type typ=static_cast<Type>(buffer[0] & 0xF0);
   if (tts.find(typ) != tts.end())
     t=tts[typ];
@@ -897,7 +974,7 @@ void MqttMessage::hexdump(const char* prefix) const
   const char* hex_to_str = " | ";
   const char* separator = hex_to_str;
   const char* half_sep = " - ";
-  std::string ascii;
+  string ascii;
 
   Console << prefix << " size(" << buffer.size() << "), state=" << state << endl;
 

src/TinyMqtt.h

@@ -4,10 +4,6 @@
 #ifndef TINY_MQTT_DEBUG
 #define TINY_MQTT_DEBUG 0
 #endif
-#ifndef TINY_MQTT_DEFAULT_ALIVE
-#define TINY_MQTT_DEFAULT_ALIVE 10
-#endif
-#define TINY_MQTT_CLIENT_ALIVE_TOLERANCE 5
 
 // 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
@@ -57,15 +53,6 @@
   #define debug(what) {}
 #endif
 
-#include <TinyConsole.h>
-#if 0
-#define dclass { Console << __LINE__ << ':' << __PRETTY_FUNCTION__ <<  ", this=" << (long)this << endl; }
-#define dtor { Console << __LINE__ << ": ~" << __PRETTY_FUNCTION__ << ", this=" << (long)this << endl; }
-#else
-#define dclass
-#define dtor
-#endif
-
 #ifdef TINY_MQTT_ASYNC
   using TcpClient = AsyncClient;
   using TcpServer = AsyncServer;
@@ -81,12 +68,15 @@ enum __attribute__((packed)) MqttError
   MqttInvalidMessage=2,
 };
 
+using string = TinyConsole::string;
+
 class Topic : public IndexedString
 {
   public:
+    Topic(const string& m) : IndexedString(m){}
     Topic(const char* s, uint8_t len) : IndexedString(s,len){}
     Topic(const char* s) : Topic(s, strlen(s)) {}
-    Topic(const std::string s) : Topic(s.c_str(), s.length()){};
+    // Topic(const string s) : Topic(s.c_str(), s.length()){};
 
     const char* c_str() const { return str().c_str(); }
 
@@ -131,11 +121,14 @@ 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 );
-    void add(const std::string& s) { add(s.c_str(), s.length()); }
+    void add(const string& s) { add(s.c_str(), s.length()); }
     void add(const Topic& t) { add(t.str()); }
     const char* end() const { return &buffer[0]+buffer.size(); }
     const char* getVHeader() const { return &buffer[vheader]; }
@@ -166,10 +159,19 @@ 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();
 
-    std::string buffer;
+    string buffer;
     uint8_t vheader;
     uint16_t size;  // bytes left to receive
     State state;
@@ -186,9 +188,14 @@ class MqttClient
     FlagWillQos = 16 | 8,  // unsupported
     FlagWill = 4,          // unsupported
     FlagCleanSession = 2,  // unsupported
+    FlagReserved = 1
+  };
 
-    FlagReserved = 1,      // use reserved as connected (save 1 byte)
+  enum __attribute__((packed)) CltFlags
-    FlagConnected = 1
+  {
+    CltFlagNone = 0,
+    CltFlagConnected = 1,
+    CltFlagToDelete = 2
   };
   public:
 
@@ -196,13 +203,15 @@ class MqttClient
 
     /** Constructor. Broker is the adress of a local broker if not null
         If you want to connect elsewhere, leave broker null and use connect() **/
-    MqttClient(MqttBroker* broker = nullptr, const std::string& id = TINY_MQTT_DEFAULT_CLIENT_ID);
+    MqttClient(MqttBroker* broker = nullptr, const string& id = TINY_MQTT_DEFAULT_CLIENT_ID);
-    MqttClient(const std::string& id) : MqttClient(nullptr, id){ dclass; }
+    MqttClient(const string& id) : MqttClient(nullptr, id){}
 
     ~MqttClient();
 
     void connect(MqttBroker* local_broker);
-    void connect(std::string broker, uint16_t port, uint16_t keep_alive = TINY_MQTT_DEFAULT_ALIVE);
+    void connect(string broker, uint16_t port, uint16_t keep_alive = 10);
+    void connect(const IPAddress& ip, uint16_t port, 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
@@ -217,8 +226,8 @@ class MqttClient
       if (tcp_client) tcp_client->write(buf, length);
     }
 
-    const std::string& id() const { return clientId; }
+    const string& id() const { return clientId; }
-    void id(const std::string& new_id) { clientId = new_id; }
+    void id(const string& new_id) { clientId = new_id; }
 
     /** Should be called in main loop() */
     void loop();
@@ -233,11 +242,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 std::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);
@@ -247,7 +256,7 @@ class MqttClient
     // TODO seems to be useless
     bool isLocal() const { return tcp_client == nullptr; }
 
-    void dump(std::string indent="")
+    void dump(string indent="")
     {
       (void)indent;
       #if TINY_MQTT_DEBUG
@@ -284,6 +293,9 @@ class MqttClient
     uint32_t keepAlive() const { return keep_alive; }
 
   private:
+    bool mqtt_connected() const { return cltFlags & CltFlagConnected; }
+    void setFlag(CltFlags f) { cltFlags |= f; }
+    void resetFlag(CltFlags f) { cltFlags &= ~f; }
 
     // event when tcp/ip link established (real or fake)
     static void onConnect(void * client_ptr, TcpClient*);
@@ -298,56 +310,50 @@ class MqttClient
     // republish a received publish if topic matches any in subscriptions
     MqttError publishIfSubscribed(const Topic& topic, MqttMessage& msg);
 
-    void clientAlive();
+    void clientAlive(uint32_t more_seconds);
     void processMessage(MqttMessage* message);
 
-    char mqtt_flags = 0;
+    uint8_t cltFlags = CltFlagNone;
-    uint16_t keep_alive = 30;
+    char mqtt_flags;
-    // for client connected to remote broker, PingReq is sent when millis() >= alive
+    uint32_t keep_alive = 30;
-    // for a client managed by a broker, disconnect it if millis() >= alive
+    uint32_t alive;
-    uint32_t alive; // PingReq if millis() > alive,
     MqttMessage message;
 
     // connection to local broker, or link to the parent
     // when MqttBroker uses MqttClient for each external connexion
     MqttBroker* local_broker=nullptr;
 
-    std::unique_ptr<TcpClient> tcp_client;    // connection to remote broker
+    TcpClient* tcp_client=nullptr;    // connection to remote broker
     std::set<Topic>  subscriptions;
-    std::string clientId;
+    string clientId;
     CallBack callback = nullptr;
 };
 
 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() { if (server) server->begin(); }
+    void begin() { server->begin(); }
     void loop();
 
-    void connect(const std::string& host, uint16_t port=1883);
+    /** Connect the broker to a parent broker */
-    bool connected() const { return state == Connected; }
+    void connect(const string& host, uint16_t port=1883);
+    /** returns true if connected to another broker */
+    bool connected() const { return remote_broker ? remote_broker->connected() : false; }
 
     size_t clientsCount() const { return clients.size(); }
+    void retain(uint8_t size) { retain_size = size; }
 
-    void dump(std::string indent="")
+    void dump(string indent="")
     {
-      for(auto& client: clients)
+      for(auto client: clients)
         client->dump(indent);
     }
 
-    size_t localClientsCount() const { return local_clients.size(); }
+    const std::vector<MqttClient*>  getClients() const { return clients; }
-    using Clients = std::vector<MqttClient*>;
-    const Clients& getClients() const { return clients; }
 
   private:
     friend class MqttClient;
@@ -359,25 +365,43 @@ 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* local) { local_clients.insert(local); }
+    void addClient(MqttClient* client);
     void removeClient(MqttClient* client);
 
     bool compareString(const char* good, const char* str, uint8_t str_len) const;
-    Clients clients;
+    std::vector<MqttClient*>  clients;
-    std::set<MqttClient*> local_clients;
 
   private:
-    std::unique_ptr<TcpServer> server;
+    TcpServer* server = nullptr;
 
     const char* auth_user = "guest";
     const char* auth_password = "guest";
     MqttClient* remote_broker = nullptr;
 
-    State state = Disconnected;
+    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

@@ -1,11 +1,22 @@
 SUB=
 
+all:runtests
+
 tests:
 	@set -e; \
-	for i in ${SUB}*-tests/Makefile; do \
+	for i in $(SUB)*-tests/Makefile; do \
 		echo '==== Making:' $$(dirname $$i); \
 		$(MAKE) -C $$(dirname $$i) -j; \
 	done
+	$(MAKE) -C compile-test
+
+valgrind:
+	@set -e; \
+	$(MAKE) tests; \
+	for i in $(SUB)*-tests/Makefile; do \
+		echo '==== Running:' $$(dirname $$i); \
+		valgrind $$(dirname $$i)/$$(dirname $$i).out; \
+	done
 
 debugtest:
 	@set -e; \
@@ -13,18 +24,17 @@ debugtest:
 	$(MAKE) -C debug-mode -j; \
 	debug-mode/debug-tests.out
 
-runtests: debugtest
+runtests:
-	@$(MAKE) clean
-	@$(MAKE) tests
 	@set -e; \
-	for i in ${SUB}*-tests/Makefile; do \
+	$(MAKE) tests; \
+	for i in $(SUB)*-tests/Makefile; do \
 		echo '==== Running:' $$(dirname $$i); \
 		$$(dirname $$i)/$$(dirname $$i).out; \
 	done
 
 clean:
 	@set -e; \
-	for i in ${SUB}*-tests/Makefile; do \
+	for i in $(SUB)*-tests/Makefile; do \
 		echo '==== Cleaning:' $$(dirname $$i); \
 		$(MAKE) -C $$(dirname $$i) clean; \
 	done

tests/Makefile.opts

@@ -0,0 +1,11 @@
+
+# GCC
+# CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
+EXTRA_CXXFLAGS=-g3 -O0 -std=c++17
+
+CXXFLAGS=-D_GNU_SOURCE -Werror=return-type -std=gnu++17 -Wall -g3 -O0
+
+# CLANG SANITIZE
+# CXX=clang
+# EXTRA_CXXFLAGS=-g3 -O0 -fsanitize=memory
+# LDFLAGS = -lpthread -lstdc++

tests/classbind-tests/Makefile

@@ -3,9 +3,6 @@
 
 EXTRA_CXXFLAGS=-g3 -O0 -DTINY_MQTT_TESTS
 
-# Remove flto flag from EpoxyDuino (too many <optimized out>)
-CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics -DEPOXY_TEST
-
 APP_NAME := classbind-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi  ESPAsyncTCP TinyConsole
 ARDUINO_LIB_DIRS := ../../../EspMock/libraries

tests/classbind-tests/classbind-tests.ino

@@ -17,9 +17,10 @@ class TestReceiver : public MqttClassBinder<TestReceiver>
   public:
     TestReceiver(const char* name) : MqttClassBinder(), name_(name) {}
 
-    void onPublish(const MqttClient* /* source */, const Topic& topic, const char* payload, size_t /* length */)
+    void onPublish(const MqttClient* /* source */, const Topic& topic, const char* /* payload */, size_t /* length */)
     {
-      Serial << "--> routed message received by " << name_ << ':' << topic.c_str() << " = " << payload << endl;
+      (void) topic;
+      // Serial << "--> routed message received by " << name_ << ':' << topic.c_str() << " = " << payload << endl;
       messages[name_]++;
     }
 
@@ -35,7 +36,8 @@ std::map<std::string, int> TestReceiver::messages;
 static int unrouted = 0;
 void onUnrouted(const MqttClient*, const Topic& topic, const char*, size_t)
 {
-  Serial << "--> unrouted: " << topic.c_str() << endl;
+  (void) topic;
+  // Serial << "--> unrouted: " << topic.c_str() << endl;
   unrouted++;
 }
 
@@ -127,52 +129,8 @@ void reset_and_start_servers(int n, bool early_accept = true)
   }
 }
 
-test(classbind_two_subscribers_binded_one_sender_wildcard)
-{
-  EpoxyTest::set_millis(0);
-  reset_and_start_servers(2, true);
-  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 mqtt_a(&broker, "mqtt_a");
-  MqttClient mqtt_b(&broker, "mqtt_a");
-  MqttClient mqtt_sender(&broker, "sender");
-
-  broker.loop();
-
-  assertTrue(mqtt_a.connected());
-  assertTrue(mqtt_b.connected());
-
-  TestReceiver receiver("receiver");
-  MqttClassBinder<TestReceiver>::onPublish(&mqtt_a, &receiver);
-  MqttClassBinder<TestReceiver>::onPublish(&mqtt_b, &receiver);
-
-  mqtt_a.subscribe("#");
-  mqtt_b.subscribe("#");
-  mqtt_sender.publish("a/b", "ab");
-
-  for (int i =0; i<10; i++)
-  {
-    EpoxyTest::add_millis(100);
-    mqtt_a.loop();
-    mqtt_b.loop();
-    mqtt_sender.loop();
-    broker.loop();
-  }
-
-  assertEqual(TestReceiver::messages["receiver"], 2);
-  assertEqual(unrouted, 0);
-  EpoxyTest::set_real_time();
-}
-
 test(classbind_one_client_receives_the_message)
 {
-  EpoxyTest::set_millis(0);
   reset_and_start_servers(2, true);
   assertEqual(WiFi.status(), WL_CONNECTED);
 
@@ -182,7 +140,7 @@ test(classbind_one_client_receives_the_message)
 
   // We have a 2nd ESP in order to test through wifi (opposed to local)
   ESP8266WiFiClass::selectInstance(2);
-  MqttClient client("sender");
+  MqttClient client;
   client.connect(ip_broker.toString().c_str(), 1883);
   broker.loop();
   assertTrue(client.connected());
@@ -195,14 +153,12 @@ test(classbind_one_client_receives_the_message)
 
   for (int i =0; i<10; i++)
   {
-    EpoxyTest::add_millis(100);
     client.loop();
     broker.loop();
   }
 
   assertEqual(TestReceiver::messages["receiver"], 1);
   assertEqual(unrouted, 0);
-  EpoxyTest::set_real_time();
 }
 
 test(classbind_routes_should_be_empty_when_receiver_goes_out_of_scope)
@@ -384,7 +340,7 @@ void setup() {
   while(!Serial);
   */
 
-  Serial.println("=============[ CLASS BINDER TinyMqtt TESTS       ]========================");
+  Serial.println("=============[ TinyMqtt class-bind TESTS       ]========================");
 
   WiFi.mode(WIFI_STA);
   WiFi.begin("network", "password");

tests/compile-test/Makefile

@@ -0,0 +1,11 @@
+# See https://github.com/bxparks/EpoxyDuino for documentation about this
+# Makefile to compile and run Arduino programs natively on Linux or MacOS.
+
+include ../Makefile.opts
+
+APP_NAME := tinymqtt-test
+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

tests/compile-test/tinymqtt-test.ino

@@ -0,0 +1,848 @@
+// 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/debug-mode/Makefile

@@ -1,7 +1,7 @@
 # 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
+EXTRA_CXXFLAGS=-g3 -O0 -DTINY_MQTT_DEBUG
 
 # Remove flto flag from EpoxyDuino (too many <optimized out>)
 CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics

tests/local-tests/Makefile

@@ -1,10 +1,7 @@
 # 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 -DTINY_MQTT_DEFAULT_ALIVE=1 -DEPOXY_TEST
+include ../Makefile.opts
-
-# 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 TinyConsole

tests/local-tests/local-tests.ino

@@ -12,53 +12,46 @@
   * Also, this will allow to mock and thus run Action on github
   **/
 
-using namespace std;
+using string = TinyConsole::string;
 
+MqttBroker broker(1883);
 
-std::map<std::string, std::map<Topic, int>>  published;    // map[client_id] => map[topic] = count
+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;
 }
 
+test(local_not_connected_by_default)
+{
+  MqttClient client;
+  assertEqual(client.connected(), false);
+
+  MqttBroker broker(1883);
+  assertEqual(broker.connected(), false);
+}
+
 test(local_client_should_unregister_when_destroyed)
 {
-  MqttBroker broker(1883);
+  assertEqual(broker.clientsCount(), (size_t)0);
-  assertEqual(broker.localClientsCount(), (size_t)0);
   {
+    assertEqual(broker.clientsCount(), (size_t)0);  // Ensure client is not yet connected
     MqttClient client(&broker);
-    assertEqual(broker.localClientsCount(), (size_t)1);  // Ensure client is now connected
+    assertEqual(broker.clientsCount(), (size_t)1);  // Ensure client is now connected
   }
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 }
 
-test(local_client_alive)
+test(local_client_do_not_disconnect_after_publishing_and_long_inactivity)
-{
-  EpoxyTest::set_millis(0);
-  MqttBroker broker(1883);
-  MqttClient client(&broker);
-
-  broker.loop();
-  assertEqual(broker.localClientsCount(), (size_t)1);  // Ensure client is now connected
-
-  EpoxyTest::add_millis(TINY_MQTT_DEFAULT_ALIVE*1000/2);
-  broker.loop();
-  assertEqual(broker.localClientsCount(), (size_t)1);  // Ensure client is still connected
-
-  EpoxyTest::add_seconds(TINY_MQTT_DEFAULT_ALIVE*5);
-  broker.loop();
-  assertEqual(broker.localClientsCount(), (size_t)1);  // Ensure client is still connected
-}
-
-test(local_wildcard_subscribe)
 {
+  published.clear();
   EpoxyTest::set_millis(0);
   MqttBroker broker(1883);
   MqttClient client(&broker, "client");
@@ -68,58 +61,101 @@ test(local_wildcard_subscribe)
   client.subscribe("#");
   client.subscribe("test");
   client.setCallback(onPublish);
-  assertEqual(broker.localClientsCount(), (size_t)2);
+  assertEqual(broker.clientsCount(), (size_t)2);
 
   sender.publish("test", "value");
   broker.loop();
 
-  assertEqual(published.size(), (size_t)1);  // client has received something
+  EpoxyTest::add_seconds(600);
-}
-
-test(local_client_do_not_disconnect_after_publishing)
-{
-  EpoxyTest::set_millis(0);
-  MqttBroker broker(1883);
-  MqttClient client(&broker, "client");
-  MqttClient sender(&broker, "sender");
-  broker.loop();
-
-  client.subscribe("#");
-  client.subscribe("test");
-  client.setCallback(onPublish);
-  assertEqual(broker.localClientsCount(), (size_t)2);
-
-  sender.publish("test", "value");
-  broker.loop();
-
-  EpoxyTest::add_seconds(60);
   client.loop();
   sender.loop();
   broker.loop();
 
-  assertEqual(broker.localClientsCount(), (size_t)2);
+  sender.publish("test", "value");
+  broker.loop();
+  sender.loop();
+  broker.loop();
+
+  assertEqual(broker.clientsCount(), (size_t)2);
   assertEqual(sender.connected(), true);
   assertEqual(client.connected(), true);
 
   assertEqual(published.size(), (size_t)1);  // client has received something
 }
 
-#if 0
+test(local_connect)
+{
+  assertEqual(broker.clientsCount(), (size_t)0);
+
+  MqttClient client(&broker);
+  assertTrue(client.connected());
+  assertEqual(broker.clientsCount(), (size_t)1);
+}
+
+test(local_publish_to_nowhere)
+{
+  published.clear();
+  assertEqual(broker.clientsCount(), (size_t)0);
+
+  MqttClient publisher;
+  MqttError status = publisher.publish("a/b");
+  assertEqual(status, MqttError::MqttNowhereToSend);
+}
+
+test(local_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(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();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
-  MqttClient subscriber_a("A");
+  MqttClient subscriber_a(&broker, "A");
   subscriber_a.setCallback(onPublish);
   subscriber_a.subscribe("a/b");
   subscriber_a.subscribe("a/c");
 
-  MqttClient subscriber_b("B");
+  MqttClient subscriber_b(&broker, "B");
   subscriber_b.setCallback(onPublish);
   subscriber_b.subscribe("a/b");
 
-  MqttClient publisher;
+  MqttClient publisher(&broker);
   publisher.publish("a/b");
   publisher.publish("a/c");
 
@@ -133,13 +169,13 @@ test(local_publish_should_be_dispatched_to_local_clients)
 test(local_unsubscribe)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
-  MqttClient subscriber;
+  MqttClient subscriber(&broker, "");
   subscriber.setCallback(onPublish);
   subscriber.subscribe("a/b");
 
-  MqttClient publisher;
+  MqttClient publisher(&broker);
   publisher.publish("a/b");
 
   subscriber.unsubscribe("a/b");
@@ -153,11 +189,11 @@ test(local_unsubscribe)
 test(local_nocallback_when_destroyed)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
-  MqttClient publisher;
+  MqttClient publisher(&broker);
   {
-    MqttClient subscriber;
+    MqttClient subscriber(&broker);
     subscriber.setCallback(onPublish);
     subscriber.subscribe("a/b");
     publisher.publish("a/b");
@@ -167,7 +203,6 @@ test(local_nocallback_when_destroyed)
 
   assertEqual(published.size(), (size_t)1);  // Only one publish has been received
 }
-#endif
 
 //----------------------------------------------------------------------------
 // setup() and loop()

tests/network-tests/Makefile

@@ -1,10 +1,10 @@
 # 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
+include ../Makefile.opts
 
 # Remove flto flag from EpoxyDuino (too many <optimized out>)
-CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics -DEPOXY_TEST
+# CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
 
 APP_NAME := network-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi  ESPAsyncTCP TinyConsole

tests/network-tests/network-tests.ino

@@ -9,16 +9,6 @@
 #include <string>
 #include <iostream>
 
-uint32_t getClientKeepAlive(MqttBroker& broker)
-{
-  if (broker.getClients().size() == 1)
-    for (auto& it : broker.getClients())
-      return it->keepAlive();
-
-  return 9999;
-}
-
-
 /**
   * TinyMqtt network unit tests.
   *
@@ -26,6 +16,8 @@ uint32_t getClientKeepAlive(MqttBroker& broker)
   * Checks with a local broker. Clients must connect to the local broker
   **/
 
+using string = TinyConsole::string;
+
 // 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)
 {
@@ -88,12 +80,12 @@ String toString(const IPAddress& ip)
 
 MqttBroker broker(1883);
 
-std::map<std::string, std::map<Topic, int>>  published;    // map[client_id] => map[topic] = count
+std::map<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)
+void start_many_wifi_esp(int n, bool early_accept = true)
 {
     ESP8266WiFiClass::resetInstances();
     ESP8266WiFiClass::earlyAccept = early_accept;
@@ -115,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);
 
@@ -127,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);
@@ -152,50 +144,10 @@ test(suback)
   assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
 }
 
-test(network_client_alive)
+test(client_keep_alive_high)
-{
-  const uint32_t keep_alive=1;
-  start_servers(2, true);
-  assertEqual(WiFi.status(), WL_CONNECTED);
-  EpoxyTest::set_millis(0); // Enter simulated time
-
-  MqttBroker broker(1883);
-  broker.begin();
-  IPAddress broker_ip = WiFi.localIP();
-
-  ESP8266WiFiClass::selectInstance(2);
-  MqttClient client;
-  client.connect(broker_ip.toString().c_str(), 1883, keep_alive);
-  broker.loop();
-  client.loop();
-
-  assertTrue(broker.clientsCount() == 1);
-  assertTrue(client.connected());
-
-  uint32_t ka = getClientKeepAlive(broker);
-  assertEqual(ka, keep_alive);
-  assertEqual(broker.clientsCount(), (size_t)1);
-
-  // All is going well if we call client.loop()
-  // The client is able to send PingReq to the broker
-  EpoxyTest::add_seconds(keep_alive);
-  client.loop();
-  broker.loop();
-  assertEqual(broker.clientsCount(), (size_t)1);
-
-  // Now simulate that the client is frozen for
-  // a too long time
-  EpoxyTest::add_seconds(TINY_MQTT_CLIENT_ALIVE_TOLERANCE*2);
-  broker.loop();
-  assertEqual(broker.clientsCount(), (size_t)0);
-
-  EpoxyTest::set_real_time();
-}
-
-test(network_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);
@@ -222,14 +174,121 @@ test(network_client_keep_alive_high)
   uint32_t sz = broker.getClients().size();
   assertEqual(sz , (uint32_t)1);
 
-  uint32_t ka = getClientKeepAlive(broker);
+  uint32_t ka = broker.getClients()[0]->keepAlive();
   assertEqual(ka, keep_alive);
 
 }
 
-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);
+
+  // 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;
+  remote_client.connect(broker_ip, 1883);
+  remote_client.setCallback(onPublish);
+
+  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);
+
+  // Should not have received anything yet
+  assertEqual(published.size(), (size_t)0);
+
+  // Now, remote client subscribes to topic
+  remote_client.subscribe("topic");
+  for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
+
+  // Check that the retained message is published
+  assertEqual(published.size(), (size_t)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(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);
@@ -245,9 +304,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);
 
@@ -276,9 +335,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);
 
@@ -295,8 +354,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");
@@ -312,33 +371,33 @@ test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
   assertEqual((unsigned int)lastLength, (unsigned int)sent.size());
 }
 
-test(network_local_client_should_unregister_when_destroyed)
+test(client_should_unregister_when_destroyed)
 {
   assertEqual(broker.clientsCount(), (size_t)0);
   {
     MqttClient client(&broker);
-    assertEqual(broker.localClientsCount(), (size_t)1);
+    assertEqual(broker.clientsCount(), (size_t)1);
   }
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  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)
+test(connect)
 {
   assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient client(&broker);
   assertTrue(client.connected());
-  assertEqual(broker.localClientsCount(), (size_t)1);
+  assertEqual(broker.clientsCount(), (size_t)1);
 }
 
-test(network_publish_should_be_dispatched)
+test(publish_should_be_dispatched)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient subscriber(&broker);
   subscriber.subscribe("a/b");
@@ -355,7 +414,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);
@@ -380,7 +439,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);
@@ -400,7 +459,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);
@@ -419,7 +478,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();
 
@@ -437,14 +496,13 @@ 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 !";
+  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 !";
-  const char* payload="This was decoded successfully !";
 
   MqttClient subscriber(&broker);
   subscriber.setCallback(onPublish);
-  subscriber.subscribe("a/b");          // Note -> this does not send any byte .... (nowhere to send) TODO
+  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
@@ -453,13 +511,25 @@ test(network_hudge_payload)
   assertEqual(payload, lastPayload);
   assertEqual(lastLength, strlen(payload));
   assertEqual(strcmp(payload, lastPayload), 0);
-  std::cout << "payload : " << payload << std::endl;
+}
-  std::cout << "received: " << lastPayload << std::endl;
+
+test(disconnected_when_broker_is_deleted)
+{
+  MqttBroker* broker = new MqttBroker(1883);
+  broker->begin();
+
+  MqttClient client;
+  client.connect(broker);
+  assertEqual(client.connected(), true);
+  client.publish("a", "b");
+
+  delete broker;
+  assertEqual(client.connected(), false);
 }
 
 test(connack)
 {
-  const bool view = true;
+  const bool view = false;
 
   NetworkObserver check(
     [this](const WiFiClient*, const uint8_t* buffer, size_t length)
@@ -473,7 +543,7 @@ test(connack)
     }
   );
 
-  start_servers(2, true);
+  start_many_wifi_esp(2, true);
   assertEqual(WiFi.status(), WL_CONNECTED);
 
   MqttBroker broker(1883);
@@ -506,7 +576,7 @@ void setup() {
   while(!Serial);
   */
 
-  Serial.println("=============[ FAKE NETWORK TinyMqtt TESTS       ]========================");
+  Serial.println("=============[ NETWORK TinyMqtt TESTS       ]========================");
 
   WiFi.mode(WIFI_STA);
   WiFi.begin("network", "password");
@@ -516,4 +586,5 @@ void loop() {
   aunit::TestRunner::run();
 
   if (Serial.available()) ESP.reset();
+  published.clear();  // Avoid crash in unit tests due to exit handlers
 }

tests/nowifi-tests/Makefile

@@ -1,10 +1,7 @@
 # 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
+include ../Makefile.opts
-
-# 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 TinyConsole

tests/nowifi-tests/nowifi-tests.ino

@@ -11,11 +11,11 @@
   * Checks with a local broker. Clients must connect to the local broker
   **/
 
-using namespace std;
+using string = TinyConsole::string;
 
 MqttBroker broker(1883);
 
-std::map<std::string, std::map<Topic, int>>  published;    // map[client_id] => map[topic] = count
+std::map<string, std::map<Topic, int>>  published;    // map[client_id] => map[topic] = count
 
 char* lastPayload = nullptr;
 size_t lastLength;
@@ -32,27 +32,27 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
 
 test(nowifi_client_should_unregister_when_destroyed)
 {
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
   {
     MqttClient client(&broker);
-    assertEqual(broker.localClientsCount(), (size_t)1);
+    assertEqual(broker.clientsCount(), (size_t)1);
   }
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 }
 
 test(nowifi_connect)
 {
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient client(&broker);
   assertTrue(client.connected());
-  assertEqual(broker.localClientsCount(), (size_t)1);
+  assertEqual(broker.clientsCount(), (size_t)1);
 }
 
 test(nowifi_publish_should_be_dispatched)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient subscriber(&broker);
   subscriber.subscribe("a/b");
@@ -72,7 +72,7 @@ test(nowifi_publish_should_be_dispatched)
 test(nowifi_publish_should_be_dispatched_to_clients)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient subscriber_a(&broker, "A");
   subscriber_a.setCallback(onPublish);
@@ -97,7 +97,7 @@ test(nowifi_publish_should_be_dispatched_to_clients)
 test(nowifi_subscribe_with_star_wildcard)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient subscriber(&broker, "A");
   subscriber.setCallback(onPublish);
@@ -118,7 +118,7 @@ test(nowifi_subscribe_with_star_wildcard)
 test(nowifi_subscribe_with_plus_wildcard)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient subscriber(&broker, "A");
   subscriber.setCallback(onPublish);
@@ -139,7 +139,7 @@ test(nowifi_subscribe_with_plus_wildcard)
 test(nowifi_should_not_receive_sys_msg)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient subscriber(&broker, "A");
   subscriber.setCallback(onPublish);
@@ -154,7 +154,7 @@ test(nowifi_should_not_receive_sys_msg)
 test(nowifi_subscribe_with_mixed_wildcards)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient subscriber(&broker, "A");
   subscriber.setCallback(onPublish);
@@ -173,7 +173,7 @@ test(nowifi_subscribe_with_mixed_wildcards)
 test(nowifi_unsubscribe_with_wildcards)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient subscriber(&broker, "A");
   subscriber.setCallback(onPublish);
@@ -195,7 +195,7 @@ test(nowifi_unsubscribe_with_wildcards)
 test(nowifi_unsubscribe)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient subscriber(&broker);
   subscriber.setCallback(onPublish);
@@ -215,7 +215,7 @@ test(nowifi_unsubscribe)
 test(nowifi_nocallback_when_destroyed)
 {
   published.clear();
-  assertEqual(broker.localClientsCount(), (size_t)0);
+  assertEqual(broker.clientsCount(), (size_t)0);
 
   MqttClient publisher(&broker);
 
@@ -279,4 +279,5 @@ void loop() {
   aunit::TestRunner::run();
 
   if (Serial.available()) ESP.reset();
+  published.clear();  // Avoid crash at exit handlers
 }

tests/string-indexer-tests/Makefile

@@ -1,7 +1,7 @@
 # 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
+include ../Makefile.opts
 
 APP_NAME := string-indexer-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi  ESPAsync TinyConsole

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

@@ -9,7 +9,7 @@
   *
   **/
 
-using namespace std;
+using string = TinyConsole::string;
 
 test(indexer_empty)
 {
@@ -84,7 +84,7 @@ test(indexer_indexed_operator_eq)
 
 test(indexer_get_string)
 {
-  std::string sone("one");
+  string sone("one");
   IndexedString one(sone);
 
   assertTrue(sone==one.str());

tests/topic-tests/Makefile

@@ -1,7 +1,7 @@
 # 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
+include ../Makefile.opts
 
 APP_NAME := topic-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi  ESPAsync TinyConsole

tests/topic-tests/topic-tests.ino

@@ -5,26 +5,22 @@
 #include <map>
 #include <iostream>
 
-#define endl "\n"
-
 /**
   * TinyMqtt / StringIndexer unit tests.
   *
   **/
 
-using namespace std;
-
 bool testTopicMatch(const char* a, const char* b, bool expected)
 {
   Topic ta(a);
   Topic tb(b);
   bool match(ta.matches(tb));
-  cout << "  " << ta.c_str() << ' ';
+  std::cout << "  " << ta.c_str() << ' ';
   if (match != expected)
-    cout << (expected ? " should match " : " should not match ");
+    std::cout << (expected ? " should match " : " should not match ");
   else
-    cout << (expected ? " matches " : " unmatches ");
+    std::cout << (expected ? " matches " : " unmatches ");
-  cout << tb.c_str() << endl;
+  std::cout << tb.c_str() << std::endl;
   return expected == match;
 }