Very promising async commit

AsyncTcp

.gitignore

@@ -1,5 +0,0 @@
-*~
-src/my_credentials.h
-*.o
-*.swp
-*.out

README.md

@@ -21,32 +21,16 @@ ESP 8266 is a small, fast and capable Mqtt Broker and Client
 - zeroconf, this is a strange but very powerful mode where
   all brokers tries to connect together on the same local network.
 
-## TODO List
-* Use [Async library](https://github.com/me-no-dev/ESPAsyncTCP)
-* Implement zeroconf mode (needs async)
-* Add a max_clients in MqttBroker. Used with zeroconf, there will be
-no need for having tons of clients (also RAM is the problem with many clients)
-* Why not a 'global' TinyMqtt::loop() instead of having to call loop for all broker/clients instances
-* Test what is the real max number of clients for broker. As far as I saw, 1k is needed per client which would make more than 30 clients critical.
-* ~~MqttMessage uses a buffer 256 bytes which is usually far than needed.~~
-* ~~MqttClient does not support more than one subscription at time~~
-* ~~MqttClient auto re-subscribe (::resubscribe works bad on broker.emqx.io)~~
-* MqttClient auto reconnection
-* ~~MqttClient unsubscribe~~
-* MqttClient does not sent payload to callback...
-* MqttClient user/password
-* Wildcards (I may implement only # as I'm not interrested by a clever and cpu consuming matching)
-
 ## Quickstart
 
 * install [TinyMqtt library](https://github.com/hsaturn/TinyMqtt)
+  (you can use the Arduino library manager and search for TinyMqtt)
 * modify <libraries/TinyMqtt/src/my_credentials.h> (wifi setup)
 
 ## Examples
 
-
 | Example             | Description                                |
-| ---------------------------- | --------------------------------- |
+| ------------------- | ------------------------------------------ |
 | client-without-wifi | standalone example                         |
 | simple-client       | Connect the ESP to an external Mqtt broker |
 | simple-broker       | Simple Mqtt broker with your ESP           |
@@ -57,11 +41,25 @@ no need for having tons of clients (also RAM is the problem with many clients)
 
 ## Standalone mode (zeroconf)
 -> The zeroconf mode is not yet implemented
-zerofonf clients to connect to broker on local network.
+zeroconf clients to connect to broker on local network.
 
 In Zeroconf mode, each ESP is a a broker and scans the local network.
 After a while one ESP naturally becomes a 'master' and all ESP are connected together.
 No problem if the master dies, a new master will be choosen soon.
 
+## TODO List
+* Use [Async library](https://github.com/me-no-dev/ESPAsyncTCP)
+* Implement zeroconf mode (needs async)
+* Add a max_clients in MqttBroker. Used with zeroconf, there will be
+no need for having tons of clients (also RAM is the problem with many clients)
+* Why not a 'global' TinyMqtt::loop() instead of having to call loop for all broker/clients instances
+* Test what is the real max number of clients for broker. As far as I saw, 1k is needed per client which would make more than 30 clients critical.
+* ~~MqttClient auto re-subscribe (::resubscribe works bad on broker.emqx.io)~~
+* MqttClient auto reconnection
+* MqttClient user/password
+* Wildcards (I may implement only # as I'm not interrested by a clever and cpu consuming matching)
+* I suspect that MqttClient::parent could be removed and replaced with a simple boolean
+  (this'll need to rewrite a few functions)
+
 ## License
 Gnu GPL 3.0, see [LICENSE](https://github.com/hsaturn/TinyMqtt/blob/main/LICENSE).

examples/tinymqtt-test/tinymqtt-test.ino

@@ -1,6 +1,7 @@
-#define TINY_MQTT_DEBUG
 #include <TinyMqtt.h>       // https://github.com/hsaturn/TinyMqtt
 #include <MqttStreaming.h>
+#include <ESP8266mDNS.h>
+
 #include <sstream>
 #include <map>
 
@@ -55,6 +56,14 @@ void setup()
   Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
 	Serial << "Type help for more..." << endl;
 
+  const char* name="tinytest";
+  Serial << "Starting MDNS, name= " << name;
+  if (!MDNS.begin(name))
+    Serial << "  error, not available." << endl;
+  else
+    Serial << " ok." << endl;
+
+
 	MqttBroker* broker = new MqttBroker(1883);
 	broker->begin();
 	brokers["broker"] = broker;
@@ -126,10 +135,10 @@ std::string getip(std::string& str, const char* if_empty=nullptr, char sep=' ')
 std::map<std::string, std::string> vars;
 
 std::set<std::string> commands = {
-	"auto", "broker", "client", "connect",
+	"auto", "broker", "blink", "client", "connect",
 	"create", "delete", "help", "interval",
 	"ls", "ip", "off", "on", "set",
-	"publish", "reset", "subscribe", "view"
+	"publish", "reset", "subscribe", "unsubscribe", "view"
 };
 
 void getCommand(std::string& search)
@@ -313,9 +322,39 @@ bool compare(std::string s, const char* cmd)
 
 using ClientFunction = void(*)(std::string& cmd, MqttClient* publish);
 
+uint32_t blink_ms_on[16];
+uint32_t blink_ms_off[16];
+uint32_t blink_next[16];
+bool blink_state[16];
+int16_t blink;
 void loop()
 {
+	auto ms=millis();
+	int8_t out=1;
+	int16_t blink_bits = blink;
+	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++;
+	}
+
 	static long count;
+  MDNS.update();
+
 	if (MqttClient::counter != count)
 	{
 		Serial << "# " << MqttClient::counter << endl;
@@ -453,11 +492,33 @@ void loop()
 					{
 						client->subscribe(getword(cmd, topic.c_str()));
 					}
+					else if (compare(s, "unsubscribe"))
+					{
+						client->unsubscribe(getword(cmd, topic.c_str()));
+					}
 					else if (compare(s, "view"))
 					{
 						client->dump();
 					}
 				}
+				else if (compare(s, "blink"))
+				{
+					uint8_t blink_nr = getint(cmd, 0);
+					if (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]);
+						pinMode(blink_nr, OUTPUT);
+						blink_next[blink_nr] = millis();
+						Serial << "Blink " << blink_nr << ' ' << (blink_ms_on[blink_nr] ? "on" : "off") << endl;
+						if (blink_ms_on[blink_nr])
+							blink |= 1<< (blink_nr-1);
+						else
+						{
+							blink &= ~(1<<(blink_nr-1));
+						}
+					}
+				}
 				else if (compare(s, "auto"))
 				{
 					automatic::command(client, cmd);
@@ -565,7 +626,7 @@ void loop()
 					Serial << "  MqttClient:" << endl;
 					Serial << "    client {name} {parent broker} : create a client then" << endl;
 					Serial << "      name.connect  [ip] [port] [alive]" << endl;
-					Serial << "      name.subscribe [topic]" << endl;
+					Serial << "      name.[un]subscribe [topic]" << endl;
 					Serial << "      name.publish [topic][payload]" << endl;
 					Serial << "      name.view" << endl;
 					Serial << "      name.delete" << endl;
@@ -573,6 +634,7 @@ void loop()
 					automatic::help();
 					Serial << endl;
 					Serial << "    help" << endl;
+					Serial << "    blink [Dx on_ms off_ms]" << endl;
 					Serial << "    ls / ip / reset" << endl;
 					Serial << "    set [name][value]" << endl;
 					Serial << "    !  repeat last command" << endl;

keywords.txt

@@ -9,13 +9,19 @@
 TinyMqtt    KEYWORD1
 
 MqttBroker  KEYWORD1
+connect		  KEYWORD2
+clientsCount KEYWORD2
 begin				KEYWORD2
 loop				KEYWORD2
+port				KEYWORD2
 
 MqttClient  KEYWORD1
+connect		  KEYWORD2
+connected	  KEYWORD2
 publish     KEYWORD2
 setCallback	KEYWORD2
 subscribe	  KEYWORD2
+unsubscribe	KEYWORD2
 
 Topic				KEYWORD1
 matches			KEYWORD2

library.json

@@ -1,12 +1,12 @@
 {
     "name": "TinyMqtt",
     "keywords": "ethernet, mqtt, m2m, iot",
-    "description": "MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive MQTT messages. It does support MQTT 3.1.1 without QOS=0.",
+    "description": "MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive MQTT messages. It does support MQTT 3.1.1 with QOS=0.",
     "repository": {
         "type": "git",
         "url": "https://github.com/hsaturn/TinyMqtt.git"
     },
-    "version": "0.7.2",
+    "version": "0.7.3",
     "exclude": "",
     "examples": "examples/*/*.ino",
     "frameworks": "arduino",

library.properties

@@ -1,11 +1,11 @@
 name=TinyMqtt
-version=0.7.2
+version=0.7.3
 author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
 maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
 sentence=A tiny broker and client library for MQTT messaging.
-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. It does support MQTT 3.1.1 without QoS=0.
+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. It does support MQTT 3.1.1 with QoS=0.
 category=Communication
 url=https://github.com/hsaturn/TinyMqtt
 architectures=*
 includes=TinyMqtt.h
-depends=
+depends=AsyncTCP

src/StringIndexer.h

@@ -2,7 +2,6 @@
 #include <map>
 #include <string>
 #include <string.h>
-#include <ESP8266WiFi.h>
 
 /***
  * Allows to store up to 255 different strings with one byte class
@@ -29,7 +28,7 @@ class StringIndexer
 	public:
 		using index_t=uint8_t;
 
-		static const index_t strToIndex(const char* str, uint8_t len)
+		static index_t strToIndex(const char* str, uint8_t len)
 		{
 			for(auto it=strings.begin(); it!=strings.end(); it++)
 			{
@@ -39,7 +38,7 @@ class StringIndexer
 					return it->first;
 				}
 			}
-			for(index_t index=0; index<255; index++)
+			for(index_t index=1; index; index++)
 			{
 				if (strings.find(index)==strings.end())
 				{
@@ -80,6 +79,8 @@ class StringIndexer
 			}
 		}
 
+		static uint16_t count() { return strings.size(); }
+
 	private:
 		static std::map<index_t, StringCounter> strings;
 };
@@ -98,6 +99,8 @@ class IndexedString
 			index=StringIndexer::strToIndex(str, len);
 		}
 
+		IndexedString(const std::string& str) : IndexedString(str.c_str(), str.length()) {};
+
 		~IndexedString() { StringIndexer::release(index); }
 
 		IndexedString& operator=(const IndexedString& source)
@@ -112,6 +115,11 @@ class IndexedString
 			return i1.index < i2.index;
 		}
 
+		friend bool operator==(const IndexedString& i1, const IndexedString& i2)
+		{
+			return i1.index == i2.index;
+		}
+
 		const std::string& str() const { return StringIndexer::str(index); }
 
 		const StringIndexer::index_t& getIndex() const { return index; }

src/TinyMqtt.cpp

@@ -9,8 +9,10 @@ void outstring(const char* prefix, const char*p, uint16_t len)
 	Serial << '\'' << endl;
 }
 
-MqttBroker::MqttBroker(uint16_t port) : server(port)
+MqttBroker::MqttBroker(uint16_t port)
 {
+	server = new AsyncServer(port);
+	server->onClient(onClient, this);
 }
 
 MqttBroker::~MqttBroker()
@@ -19,14 +21,16 @@ MqttBroker::~MqttBroker()
 	{
 		delete clients[0];
 	}
-	server.close();
+	delete server;
 }
 
 // private constructor used by broker only
-MqttClient::MqttClient(MqttBroker* parent, WiFiClient& new_client)
-	: parent(parent)
+MqttClient::MqttClient(MqttBroker* parent, AsyncClient* new_client)
+	: parent(parent), client(new_client)
 {
-	client = new WiFiClient(new_client);
+	client->onData(onData, this);
+	// client->onConnect() TODO
+	// client->onDisconnect() TODO
 	alive = millis()+5000;	// client expires after 5s if no CONNECT msg
 }
 
@@ -70,8 +74,12 @@ void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
 	debug("cnx: closing");
 	close();
 	if (client) delete client;
-	client = new WiFiClient;
+	client = new AsyncClient;
 	debug("Trying to connect to " << broker.c_str() << ':' << port);
+	// TODO This may return immediately !!!
+	// TODO so I have to add onConnect and move this code to onConnect
+	// TODO also, as this is async now, I must take care of
+	// TODO the broker that may disconnect and delete the client immediately
 	if (client->connect(broker.c_str(), port))
 	{
 	  debug("cnx: connecting");
@@ -98,6 +106,13 @@ void MqttBroker::addClient(MqttClient* client)
 		clients.push_back(client);
 }
 
+void MqttBroker::connect(const std::string& host, uint16_t port)
+{
+	if (broker == nullptr) broker = new MqttClient;
+	broker->connect(host, port);
+	broker->parent = this;	// Because connect removed the link
+}
+
 void MqttBroker::removeClient(MqttClient* remove)
 {
   for(auto it=clients.begin(); it!=clients.end(); it++)
@@ -105,6 +120,11 @@ void MqttBroker::removeClient(MqttClient* 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);
 			debug("Client removed " << clients.size());
@@ -114,16 +134,24 @@ void MqttBroker::removeClient(MqttClient* remove)
 	debug("Error cannot remove client");	// TODO should not occur
 }
 
+void MqttBroker::onClient(void* broker_ptr, AsyncClient* client)
+{
+	MqttBroker* broker = static_cast<MqttBroker*>(broker_ptr);
+
+	broker->addClient(new MqttClient(broker, client));
+	debug("New client #" << broker->clients.size());
+}
+
 void MqttBroker::loop()
 {
-  WiFiClient client = server.available();
-  
-  if (client)
+	if (broker)
 	{
-		addClient(new MqttClient(this, client));
-		debug("New client (" << clients.size() << ')');
+		// TODO should monitor broker's activity.
+		// 1 When broker disconnect and reconnect we have to re-subscribe
+		broker->loop();
 	}
 
+
   // for(auto it=clients.begin(); it!=clients.end(); it++)
 	// use index because size can change during the loop
 	for(size_t i=0; i<clients.size(); i++)
@@ -143,7 +171,16 @@ void MqttBroker::loop()
 	}
 }
 
-MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg)
+MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
+{
+	if (broker && broker->connected())
+	{
+		return broker->subscribe(topic, qos);
+	}
+	return MqttNowhereToSend;
+}
+
+MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const
 {
 	MqttError retval = MqttOk;
 
@@ -152,33 +189,32 @@ MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, Mqtt
 	for(auto client: clients)
 	{
 		i++;
-#if TINY_MQTT_DEBUG
+#ifdef TINY_MQTT_DEBUG
 		Serial << "brk_" << (broker && broker->connected() ? "con" : "dis") <<
 			 "	srce=" << (source->isLocal() ? "loc" : "rem") << " clt#" << i << ", local=" << client->isLocal() << ", con=" << client->connected() << endl;
 #endif
 		bool doit = false;
-		if (broker && broker->connected())	// Broker is connected
+		if (broker && broker->connected())	// this (MqttBroker) is connected (to a external broker)
 		{
-			//    ext broker -> clients or
-			// or clients -> ext broker
-			if (source == broker)	// broker -> clients
+			// ext_broker -> clients or clients -> ext_broker
+			if (source == broker)	// external broker -> internal clients
 				doit = true;
-			else									// clients -> broker
+			else									// external clients -> this broker
 			{
-				MqttError ret = broker->publish(topic, msg);
+				// As this broker is connected to another broker, simply forward the msg
+				MqttError ret = broker->publishIfSubscribed(topic, msg);
 				if (ret != MqttOk) retval = ret;
 			}
 		}
-		else // Disconnected: R7
+		else // Disconnected
 		{
-			// All is allowed
 			doit = true;
 		}
-#if TINY_MQTT_DEBUG
+#ifdef TINY_MQTT_DEBUG
 		Serial << ", doit=" << doit << ' ';
 #endif
 
-		if (doit) retval = client->publish(topic, msg);
+		if (doit) retval = client->publishIfSubscribed(topic, msg);
 		debug("");
 	}
 	return retval;
@@ -224,21 +260,28 @@ void MqttClient::loop()
 		{
 			debug("pingreq");
 			uint16_t pingreq = MqttMessage::Type::PingReq;
-			client->write((uint8_t*)(&pingreq), 2);
+			client->write((const char*)(&pingreq), 2);
 			clientAlive(0);
 
 			// TODO when many MqttClient passes through a local browser
 			// there is no need to send one PingReq per instance.
 		}
 	}
-
-	while(client && client->available()>0)
-	{
-		message.incoming(client->read());
-		if (message.type())
-		{
-			processMessage();
 }
+
+void MqttClient::onData(void* client_ptr, AsyncClient*, void* data, size_t len)
+{
+	char* char_ptr = static_cast<char*>(data);
+	MqttClient* client=static_cast<MqttClient*>(client_ptr);
+	while(len>0)
+	{
+		client->message.incoming(*char_ptr++);
+		if (client->message.type())
+		{
+			client->processMessage(&client->message);
+			client->message.reset();
+		}
+		len--;
 	}
 }
 
@@ -273,6 +316,10 @@ MqttError MqttClient::subscribe(Topic topic, uint8_t qos)
 	{
 		return sendTopic(topic, MqttMessage::Type::Subscribe, qos);
 	}
+	else
+	{
+		return parent->subscribe(topic, qos);
+	}
 	return ret;
 }
 
@@ -307,22 +354,22 @@ MqttError MqttClient::sendTopic(const Topic& topic, MqttMessage::Type type, uint
 
 long MqttClient::counter=0;
 
-void MqttClient::processMessage()
+void MqttClient::processMessage(const MqttMessage* mesg)
 {
 	counter++;
-#if TINY_MQTT_DEBUG
-if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessage::Type::PingResp)
+#ifdef TINY_MQTT_DEBUG
+if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::Type::PingResp)
 {
-	Serial << "---> INCOMING " << _HEX(message.type()) << " client(" << (int)client << ':' << clientId << ") mem=" << ESP.getFreeHeap() << endl;
-	// message.hexdump("Incoming");
+	Serial << "---> INCOMING " << _HEX(mesg->type()) << " client(" << (int)client << ':' << clientId << ") mem=" << ESP.getFreeHeap() << endl;
+	// mesg->hexdump("Incoming");
 }
 #endif
-  auto header = message.getVHeader();
+  auto header = mesg->getVHeader();
   const char* payload;
   uint16_t len;
 	bool bclose=true;
 
-	switch(message.type() & 0XF0)
+	switch(mesg->type() & 0XF0)
 	{
 		case MqttMessage::Type::Connect:
 			if (mqtt_connected)
@@ -345,30 +392,30 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
 			}
 
 			// ClientId
-			message.getString(payload, len);
+			mesg->getString(payload, len);
 			clientId = std::string(payload, len);
 			payload += len;
 
 			if (mqtt_flags & FlagWill)	// Will topic
 			{
-				message.getString(payload, len);	// Will Topic
+				mesg->getString(payload, len);	// Will Topic
 				outstring("WillTopic", payload, len);
 				payload += len;
 
-				message.getString(payload, len);	// Will Message
+				mesg->getString(payload, len);	// Will Message
 				outstring("WillMessage", payload, len);
 				payload += len;
 			}
 			// FIXME forgetting credential is allowed (security hole)
 			if (mqtt_flags & FlagUserName)
 			{
-				message.getString(payload, len);
+				mesg->getString(payload, len);
 				if (!parent->checkUser(payload, len)) break;
 				payload += len;
 			}
 			if (mqtt_flags & FlagPassword)
 			{
-				message.getString(payload, len);
+				mesg->getString(payload, len);
 				if (!parent->checkPassword(payload, len)) break;
 				payload += len;
 			}
@@ -407,7 +454,7 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
 			if (client)
 			{
 				uint16_t pingreq = MqttMessage::Type::PingResp;
-				client->write((uint8_t*)(&pingreq), 2);
+				client->write((const char*)(&pingreq), 2);
 			  bclose = false;
 			}
 			else
@@ -422,25 +469,27 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
 				if (!mqtt_connected) break;
 				payload = header+2;
 				
-				debug("subscribe loop");
-				while(payload < message.end())
+				debug("un/subscribe loop");
+				while(payload < mesg->end())
 				{
-					message.getString(payload, len);	// Topic
+					mesg->getString(payload, len);	// Topic
 					debug( "  topic (" << std::string(payload, len) << ')');
-					outstring("Subscribes", payload, len);
+					outstring("  un/subscribes", payload, len);
 					// subscribe(Topic(payload, len));
 					Topic topic(payload, len);
-					if ((message.type() & 0XF0) == MqttMessage::Type::Subscribe)
+					payload += len;
+					if ((mesg->type() & 0XF0) == MqttMessage::Type::Subscribe)
+					{
+						uint8_t qos = *payload++;
+						if (qos != 0) debug("Unsupported QOS" << qos << endl);
 						subscriptions.insert(topic);
+					}
 					else
 					{
 						auto it=subscriptions.find(topic);
 						if (it != subscriptions.end())
 							subscriptions.erase(it);
 					}
-					payload += len;
-					uint8_t qos = *payload++;
-					debug("  qos=" << qos);
 				}
 				debug("end loop");
 				bclose = false;
@@ -449,37 +498,38 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
 			break;
 
 		case MqttMessage::Type::Publish:
-			if (!mqtt_connected) break;
+			if (mqtt_connected or client == nullptr)
 			{
-				uint8_t qos = message.type() & 0x6;
+				uint8_t qos = mesg->type() & 0x6;
 				payload = header;
-				message.getString(payload, len);
+				mesg->getString(payload, len);
 				Topic published(payload, len);
 				payload += len;
-				len=message.end()-payload;
 				// Serial << "Received Publish (" << published.str().c_str() << ") size=" << (int)len
-				// << '(' << std::string(payload, len).c_str() << ')'	<< " msglen=" << message.length() << endl; 
+				// << '(' << std::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
 				// TODO reset RETAIN
-				if (parent)
+
+				if (client==nullptr)	// internal MqttClient receives publish
+				{
+					if (callback and isSubscribedTo(published))
+					{
+						callback(this, published, payload, len);	// TODO send the real payload
+					}
+				}
+				else if (parent) // from outside to inside
 				{
 				  debug("publishing to parent");
-					parent->publish(this, published, message);
+					parent->publish(this, published, *mesg);
 				}
-				else if (callback && subscriptions.find(published)!=subscriptions.end())
-				{
-					callback(this, published, nullptr, 0);	// TODO send the real payload
-				}
-				message.create(MqttMessage::Type::PubAck);
-				// TODO re-add packet identifier if any
-				message.sendTo(this);
 				bclose = false;
 			}
 			break;
 
 		case MqttMessage::Type::Disconnect:
-			// TODO should discard any will message
+			// TODO should discard any will msg
 			if (!mqtt_connected) break;
 			mqtt_connected = false;
 			close(false);
@@ -492,8 +542,9 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
 	};
 	if (bclose)
 	{
-		Serial << "*************** Error msg 0x" << _HEX(message.type());
-		message.hexdump("-------ERROR ------");
+		Serial << "*************** Error msg 0x" << _HEX(mesg->type());
+		mesg->hexdump("-------ERROR ------");
+		dump();
 		Serial << endl;
 		close();
   }
@@ -501,7 +552,6 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
 	{
 		clientAlive(parent ? 5 : 0);
 	}
-	message.reset();
 }
 
 bool Topic::matches(const Topic& topic) const
@@ -517,8 +567,11 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
 	MqttMessage msg(MqttMessage::Publish);
 	msg.add(topic);
 	msg.add(payload, pay_length, false);
+	msg.complete();
 	if (parent)
+	{
 		return parent->publish(this, topic, msg);
+	}
 	else if (client)
 		return msg.sendTo(this);
 	else
@@ -526,29 +579,33 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
 }
 
 // republish a received publish if it matches any in subscriptions
-MqttError MqttClient::publish(const Topic& topic, MqttMessage& msg)
+MqttError MqttClient::publishIfSubscribed(const Topic& topic, const MqttMessage& msg)
 {
 	MqttError retval=MqttOk;
 
 	debug("mqttclient publish " << subscriptions.size());
-	for(const auto& subscription: subscriptions)
+	if (isSubscribedTo(topic))
 	{
-		if (subscription.matches(topic))
-		{
-			debug(" match client=" << (int32_t)client << ", topic " << topic.str().c_str() << ' ');
 		if (client)
-			{
 			retval = msg.sendTo(this);
-			}
-			else if (callback)
+		else
 		{
-				callback(this, topic, nullptr, 0);	// TODO Payload
-			}
+			processMessage(&msg);
+			// callback(this, topic, nullptr, 0);	// TODO Payload
 		}
 	}
 	return retval;
 }
 
+bool MqttClient::isSubscribedTo(const Topic& topic) const
+{
+	for(const auto& subscription: subscriptions)
+		if (subscription.matches(topic))
+			return true;
+
+	return false;
+}
+
 void MqttMessage::reset()
 {
 	buffer.clear();
@@ -617,13 +674,14 @@ void MqttMessage::add(const char* p, size_t len, bool addLength)
 {
 	if (addLength)
 	{
+		buffer.reserve(buffer.length()+addLength+2);
 		incoming(len>>8);
 		incoming(len & 0xFF);
 	}
 	while(len--) incoming(*p++);
 }
 
-void MqttMessage::encodeLength(char* msb, int length)
+void MqttMessage::encodeLength(char* msb, int length) const
 {
 	do
 	{
@@ -634,7 +692,13 @@ void MqttMessage::encodeLength(char* msb, int length)
 	} while (length);
 };
 
-MqttError MqttMessage::sendTo(MqttClient* client)
+void MqttMessage::complete()
+{
+		encodeLength(&buffer[1], buffer.size()-2);
+		state = Complete;
+}
+
+MqttError MqttMessage::sendTo(MqttClient* client) const
 {
 	if (buffer.size())
 	{

src/TinyMqtt.h

@@ -1,15 +1,17 @@
+#pragma once
 #include <ESP8266WiFi.h>
+#include <ESPAsyncTCP.h>
 #include <vector>
 #include <set>
 #include <string>
 #include "StringIndexer.h"
 #include <MqttStreaming.h>
 
-#if 0
+// #define TINY_MQTT_DEBUG
+
+#ifdef TINY_MQTT_DEBUG
   #define debug(what) { Serial << __LINE__ << ' ' << what << endl; delay(100); }
-  #define TINY_MQTT_DEBUG 1
 #else
-  #define TINY_MQTT_DEBUG 0
   #define debug(what) {}
 #endif
 
@@ -72,6 +74,7 @@ class MqttMessage
 		const char* end() const { return &buffer[0]+buffer.size(); }
 		const char* getVHeader() const { return &buffer[vheader]; }
 		uint16_t length() const { return buffer.size(); }
+		void complete();
 
 		void reset();
 
@@ -79,7 +82,6 @@ class MqttMessage
 		// output buff+=2, len=length(str)
 		static void getString(const char* &buff, uint16_t& len);
 
-
 		Type type() const
 		{
 			return state == Complete ? static_cast<Type>(buffer[0]) : Unknown;
@@ -88,18 +90,18 @@ class MqttMessage
 		void create(Type type)
 		{
 			buffer=(char)type;
-			buffer+='\0';
+			buffer+='\0';		// reserved for msg length
 			vheader=2;
 			size=0;
 			state=Create;
 		}
-		MqttError sendTo(MqttClient*);
+		MqttError sendTo(MqttClient*) const;
 		void hexdump(const char* prefix=nullptr) const;
 
 	private:
-		void encodeLength(char* msb, int length);
+		void encodeLength(char* msb, int length) const;
 
-		std::string buffer;
+		mutable std::string buffer;	// mutable -> sendTo()
 		uint8_t vheader;
 		uint16_t size;	// bytes left to receive
 		State state;
@@ -120,13 +122,15 @@ class MqttClient
 		FlagReserved = 1
 	};
 	public:
-		MqttClient(MqttBroker* brk = nullptr, const std::string& id="");
+	  /** Constructor. If broker is not null, this is the adress of a local broker.
+		    If you want to connect elsewhere, leave broker null and use connect() **/
+		MqttClient(MqttBroker* broker = nullptr, const std::string& id="");
 		MqttClient(const std::string& id) : MqttClient(nullptr, id){}
 
 		~MqttClient();
 
 		void connect(MqttBroker* parent);
-		void connect(std::string broker, uint16_t port, uint16_t ka=10);
+		void connect(std::string broker, uint16_t port, uint16_t keep_alive = 10);
 
 		bool connected() { return
 			(parent!=nullptr and client==nullptr) or
@@ -137,6 +141,7 @@ class MqttClient
 		const std::string& id() const { return clientId; }
 		void id(std::string& new_id) { clientId = new_id; }
 
+		/** Should be called in main loop() */
 		void loop();
 		void close(bool bSendDisconnect=true);
 		void setCallback(CallBack fun) {callback=fun; };
@@ -149,6 +154,7 @@ class MqttClient
 
 		MqttError subscribe(Topic topic, uint8_t qos=0);
 		MqttError unsubscribe(Topic topic);
+		bool isSubscribedTo(const Topic& topic) const;
 
 		// connected to local broker
 		// TODO seems to be useless
@@ -173,23 +179,25 @@ class MqttClient
 			Serial << "]" << endl;
 		}
 
-		static long counter;	// Number of messages sent
+		/** Count the number of messages that have been sent **/
+		static long counter;
 
 	private:
+		static void onData(void* client_ptr, AsyncClient*, void* data, size_t len);
 		MqttError sendTopic(const Topic& topic, MqttMessage::Type type, uint8_t qos);
 		void resubscribe();
 
 		friend class MqttBroker;
-		MqttClient(MqttBroker* parent, WiFiClient& client);
+		MqttClient(MqttBroker* parent, AsyncClient* client);
 		// republish a received publish if topic matches any in subscriptions
-		MqttError publish(const Topic& topic, MqttMessage& msg);
+		MqttError publishIfSubscribed(const Topic& topic, const MqttMessage& msg);
 
 		void clientAlive(uint32_t more_seconds);
-		void processMessage();
+		void processMessage(const MqttMessage* message);
 
 		bool mqtt_connected = false;
 		char mqtt_flags;
-		uint32_t keep_alive;
+		uint32_t keep_alive = 60;
 		uint32_t alive;
 		MqttMessage message;
 
@@ -198,7 +206,7 @@ class MqttClient
 		// (this is the case when MqttBroker isn't used except here)
 		MqttBroker* parent=nullptr;		// connection to local broker
 
-		WiFiClient* client=nullptr;		// connection to mqtt client or to remote broker
+		AsyncClient* client=nullptr;		// connection to mqtt client or to remote broker
 		std::set<Topic>	subscriptions;
 		std::string clientId;
 		CallBack callback = nullptr;
@@ -217,12 +225,10 @@ class MqttBroker
 		MqttBroker(uint16_t port);
 		~MqttBroker();
 
-		void begin() { server.begin(); }
+		void begin() { server->begin(); }
 		void loop();
 
-		uint16_t port() const { return server.port(); }
-
-		void connect(std::string host, uint16_t port=1883);
+		void connect(const std::string& host, uint16_t port=1883);
 		bool connected() const { return state == Connected; }
 
 		size_t clientsCount() const { return clients.size(); }
@@ -240,6 +246,7 @@ class MqttBroker
 	private:
 		friend class MqttClient;
 
+		static void onClient(void*, AsyncClient*);
 		bool checkUser(const char* user, uint8_t len) const
 		{ return compareString(auth_user, user, len); }
 
@@ -247,7 +254,9 @@ class MqttBroker
 		{ return compareString(auth_password, password, len); }
 
 
-		MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg);
+		MqttError publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const;
+
+		MqttError subscribe(const Topic& topic, uint8_t qos);
 
 		// For clients that are added not by the broker itself
 		void addClient(MqttClient* client);
@@ -255,7 +264,7 @@ class MqttBroker
 
 		bool compareString(const char* good, const char* str, uint8_t str_len) const;
 		std::vector<MqttClient*>	clients;
-		WiFiServer server;
+		AsyncServer* server;
 
 		const char* auth_user = "guest";
 		const char* auth_password = "guest";

tests/Makefile

@@ -5,7 +5,7 @@ tests:
 		$(MAKE) -C $$(dirname $$i) -j; \
 	done
 
-runtests:
+runtests: tests
 	set -e; \
 	for i in *-tests/Makefile; do \
 		echo '==== Running:' $$(dirname $$i); \

tests/local-tests/Makefile

@@ -3,4 +3,5 @@
 
 APP_NAME := local-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
-include ../../../EpoxyDuino/EpoxyDuino.mk
+ESP_LIBS = ESP8266WiFi ESPAsyncTCP
+include ../../../EspMock/EspMock.mk

tests/local-tests/local-tests.ino

@@ -6,7 +6,7 @@
 	* TinyMqtt local unit tests.
 	*
 	* Clients are connected to pseudo remote broker
-	* The remote will be 127.0.0.1:1883
+	* The remote should be 127.0.0.1:1883 <--- But this does not work due to Esp network limitations
 	* We are using 127.0.0.1 because this is simpler to test with a single ESP
 	* Also, this will allow to mock and thus run Action on github
 	**/
@@ -17,10 +17,15 @@ MqttBroker broker(1883);
 
 std::map<std::string, std::map<Topic, int>>	published;		// map[client_id] => map[topic] = count
 
+const char* 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;
+	lastLength = length;
 }
 
 test(local_client_should_unregister_when_destroyed)

tests/nowifi-tests/Makefile

@@ -3,4 +3,5 @@
 
 APP_NAME := nowifi-tests
 ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
-include ../../../EpoxyDuino/EpoxyDuino.mk
+ESP_LIBS = ESP8266WiFi ESPAsyncTCP
+include ../../../EspMock/EspMock.mk

tests/nowifi-tests/nowifi-tests.ino

@@ -6,7 +6,7 @@
   * TinyMqtt nowifi unit tests.
 	*
 	* No wifi connection unit tests.
-    * Checks with a local broker. Clients must connect to the local client
+  * Checks with a local broker. Clients must connect to the local broker
 	**/
 
 using namespace std;
@@ -15,10 +15,17 @@ MqttBroker broker(1883);
 
 std::map<std::string, std::map<Topic, int>>	published;		// map[client_id] => map[topic] = count
 
+char* lastPayload = nullptr;
+size_t lastLength;
+
 void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
 {
 	if (srce)
 		published[srce->id()][topic]++;
+	
+	if (lastPayload) free(lastPayload);
+  lastPayload = strdup(payload);
+	lastLength = length;
 }
 
 test(nowifi_client_should_unregister_when_destroyed)
@@ -56,11 +63,11 @@ test(nowifi_publish_should_be_dispatched)
 	publisher.publish("a/c");
 
 	assertEqual(published.size(), (size_t)1);	// 1 client has received something
-	assertTrue(published[""]["a/b"] == 1);
-	assertTrue(published[""]["a/c"] == 2);
+	assertEqual(published[""]["a/b"], 1);
+	assertEqual(published[""]["a/c"], 2);
 }
 
-test(nowifi_publish_should_be_dispatched_to_nowifi_clients)
+test(nowifi_publish_should_be_dispatched_to_clients)
 {
 	published.clear();
 	assertEqual(broker.clientsCount(), (size_t)0);
@@ -75,14 +82,14 @@ test(nowifi_publish_should_be_dispatched_to_nowifi_clients)
 	subscriber_b.subscribe("a/b");
 
 	MqttClient publisher(&broker);
-	publisher.publish("a/b");
-	publisher.publish("a/c");
+	publisher.publish("a/b");		// A and B should receive this
+	publisher.publish("a/c");		// A should receive this 
 
 	assertEqual(published.size(), (size_t)2);	// 2 clients have received something
-	assertTrue(published["A"]["a/b"] == 1);
-	assertTrue(published["A"]["a/c"] == 1);
-	assertTrue(published["B"]["a/b"] == 1);
-	assertTrue(published["B"]["a/c"] == 0);
+	assertEqual(published["A"]["a/b"], 1);
+	assertEqual(published["A"]["a/c"], 1);
+	assertEqual(published["B"]["a/b"], 1);
+	assertEqual(published["B"]["a/c"], 0);
 }
 
 test(nowifi_unsubscribe)
@@ -95,14 +102,14 @@ test(nowifi_unsubscribe)
 	subscriber.subscribe("a/b");
 
 	MqttClient publisher(&broker);
-	publisher.publish("a/b");
+	publisher.publish("a/b");		// This publish is received
 
 	subscriber.unsubscribe("a/b");
 
-	publisher.publish("a/b");
+	publisher.publish("a/b");		// Those one, no (unsubscribed)
 	publisher.publish("a/b");
 
-	assertTrue(published[""]["a/b"] == 1);	// Only one publish has been received
+	assertEqual(published[""]["a/b"], 1);	// Only one publish has been received
 }
 
 test(nowifi_nocallback_when_destroyed)
@@ -124,6 +131,24 @@ test(nowifi_nocallback_when_destroyed)
 	assertEqual(published.size(), (size_t)1);	// Only one publish has been received
 }
 
+test(nowifi_payload_nullptr)
+{
+	published.clear();
+
+	const char* payload="abcd";
+
+	MqttClient subscriber(&broker);
+	subscriber.setCallback(onPublish);
+	subscriber.subscribe("a/b");
+
+	MqttClient publisher(&broker);
+	publisher.publish("a/b", payload, strlen(payload));		// This publish is received
+
+  // coming from MqttClient::publish(...)
+  assertEqual(payload, lastPayload);
+	assertEqual(lastLength, (size_t)4);
+}
+
 //----------------------------------------------------------------------------
 // setup() and loop()
 void setup() {

tests/string-indexer-tests/Makefile

@@ -0,0 +1,7 @@
+# See https://github.com/bxparks/EpoxyDuino for documentation about this
+# Makefile to compile and run Arduino programs natively on Linux or MacOS.
+
+APP_NAME := string-indexer-tests
+ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
+ESP_LIBS = ESP8266WiFi ESPAsyncTCP
+include ../../../EspMock/EspMock.mk

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

@@ -0,0 +1,109 @@
+#include <AUnit.h>
+#include <StringIndexer.h>
+#include <map>
+
+/**
+	* TinyMqtt / StringIndexer unit tests.
+	*
+	**/
+
+using namespace std;
+
+test(indexer_empty)
+{
+  assertEqual(StringIndexer::count(), 0);
+}
+
+test(indexer_strings_deleted_should_empty_indexer)
+{
+  assertTrue(StringIndexer::count()==0);
+	{
+		IndexedString one("one");
+    assertEqual(StringIndexer::count(), 1);
+		IndexedString two("two");
+    assertEqual(StringIndexer::count(), 2);
+		IndexedString three("three");
+    assertEqual(StringIndexer::count(), 3);
+		IndexedString four("four");
+    assertEqual(StringIndexer::count(), 4);
+	}
+  assertEqual(StringIndexer::count(), 0);
+}
+
+test(indexer_same_strings_count_as_one)
+{
+	IndexedString one  ("one");
+	IndexedString two  ("one");
+	IndexedString three("one");
+	IndexedString fourt("one");
+
+	assertEqual(StringIndexer::count(), 1);
+}
+
+test(indexer_size_of_indexed_string)
+{
+	assertEqual(sizeof(IndexedString), (size_t)1);
+}
+
+test(indexer_different_strings_are_different)
+{
+	IndexedString one("one");
+	IndexedString two("two");
+
+	assertFalse(one == two);
+}
+
+test(indexer_same_strings_should_equal)
+{
+	IndexedString one("one");
+	IndexedString two("one");
+
+	assertTrue(one == two);
+}
+
+test(indexer_indexed_operator_eq)
+{
+	IndexedString one("one");
+	{
+		IndexedString same = one;
+		assertTrue(one == same);
+		assertEqual(StringIndexer::count(), 1);
+  }
+	assertEqual(StringIndexer::count(), 1);
+}
+
+test(indexer_get_string)
+{
+	std::string sone("one");
+	IndexedString one(sone);
+
+  assertTrue(sone==one.str());
+}
+
+test(indexer_get_index)
+{
+	IndexedString one1("one");
+	IndexedString one2("one");
+	IndexedString two1("two");
+	IndexedString two2("two");
+
+  assertTrue(one1.getIndex() == one2.getIndex());
+	assertTrue(two1.getIndex() == two2.getIndex());
+	assertTrue(one1.getIndex() != two1.getIndex());
+}
+
+//----------------------------------------------------------------------------
+// setup() and loop()
+void setup() {
+	delay(1000);
+	Serial.begin(115200);
+	while(!Serial);
+
+	Serial.println("=============[ TinyMqtt StringIndexer TESTS ]========================");
+}
+
+void loop() {
+	aunit::TestRunner::run();
+
+	if (Serial.available()) ESP.reset();
+}