Update README.md and use allman astyle

Author: khoih-prog

CONTRIBUTING.md

@@ -30,10 +30,10 @@ Arduino IDE version: v1.8.19
 ESP8266 Core Version v3.0.2
 ESP8266_NODEMCU_ESP12E
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.15.0-46-generic #49~20.04.1-Ubuntu SMP Thu Aug 4 19:15:44 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.15.0-53-generic #59~20.04.1-Ubuntu SMP Thu Oct 20 15:10:22 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
-I encountered a crash while using TimerInterrupt.
+I encountered a crash while using this library
 
 Steps to reproduce:
 1. ...
@@ -42,12 +42,32 @@ Steps to reproduce:
 4. ...
 ```
 
+---
+
 ### Sending Feature Requests
 
 Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
 
-There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP8266_PWM/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
+There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESPAsyncTCP/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
+
+---
 
 ### Sending Pull Requests
 
 Pull Requests with changes and fixes are also welcome!
+
+Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
+
+1. Change directory to the library GitHub
+
+```
+xy@xy-Inspiron-3593:~$ cd Arduino/xy/ESPAsyncTCP_GitHub/
+xy@xy-Inspiron-3593:~/Arduino/xy/ESPAsyncTCP_GitHub$
+```
+
+2. Issue astyle command
+
+```
+xy@xy-Inspiron-3593:~/Arduino/xy/ESPAsyncTCP_GitHub$ bash utils/restyle.sh
+```
+

README.md

@@ -1,11 +1,14 @@
-# ESPAsyncTCP (forked copy)
+# ESPAsyncTCP Library (forked copy)
 
 [![arduino-library-badge](https://www.ardu-badge.com/badge/ESPAsyncTCP.svg?)](https://www.ardu-badge.com/ESPAsyncTCP)
 [![GitHub release](https://img.shields.io/github/release/khoih-prog/ESPAsyncTCP.svg)](https://github.com/khoih-prog/ESPAsyncTCP/releases)
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
 [![GitHub issues](https://img.shields.io/github/issues/khoih-prog/ESPAsyncTCP.svg)](http://github.com/khoih-prog/ESPAsyncTCP/issues)
 
 
+<a href="https://profile-counter.glitch.me/khoih-prog/count.svg" title="Total khoih-prog Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog/count.svg" style="height: 30px;width: 200px;"></a>
+<a href="https://profile-counter.glitch.me/khoih-prog-ESPAsyncTCP/count.svg" title="Forked ESPAsyncTCP Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog-ESPAsyncTCP/count.svg" style="height: 30px;width: 200px;"></a>
+
 ---
 ---
 
@@ -102,16 +105,17 @@ The base classes on which everything else is built. They expose all possible sce
 
 ### AsyncPrinter
 
-This class can be used to send data like any other ```Print``` interface (```Serial``` for example).
-The object then can be used outside of the Async callbacks (the loop) and receive asynchronously data using ```onData```. The object can be checked if the underlying ```AsyncClient```is connected, or hook to the ```onDisconnect``` callback.
+This class can be used to send data like any other `Print` interface (`Serial` for example).
+
+The object then can be used outside of the Async callbacks (the loop) and receive asynchronously data using ```onData```. The object can be checked if the underlying `AsyncClient` is connected, or hook to the `onDisconnect` callback.
 
 ### AsyncTCPbuffer
 
-This class is really similar to the ```AsyncPrinter```, but it differs in the fact that it can buffer some of the incoming data.
+This class is really similar to the `AsyncPrinter`, but it differs in the fact that it can buffer some of the incoming data.
 
 ### SyncClient
 
-It is exactly what it sounds like. This is a standard, blocking TCP Client, similar to the one included in ```ESP8266WiFi```
+It is exactly what it sounds like. This is a standard, blocking TCP Client, similar to the one included in `ESP8266WiFi`
 
 ---
 ---
@@ -167,7 +171,8 @@ Submit issues to: [ESPAsyncTCP issues](https://github.com/khoih-prog/ESPAsyncTCP
 
 1. Try to convert to use with new ESP8266 cores v3.0.2+ without `axtls` support
 2. Add Table of Contents
-3. Modify examples
+3. Modify examples\
+4. Add astyle using `allman` style. Restyle the library
 
 ---
 ---
@@ -209,8 +214,8 @@ If you want to contribute to this project:
 
 ## Copyright
 
-- Copyright 2016- Hristo Gochkov
-- Copyright 2022- Khoi Hoang
+- Copyright (c) 2016- Hristo Gochkov
+- Copyright (c) 2022- Khoi Hoang
 
 
 

changelog.md

@@ -6,6 +6,10 @@
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
 [![GitHub issues](https://img.shields.io/github/issues/khoih-prog/ESPAsyncTCP.svg)](http://github.com/khoih-prog/ESPAsyncTCP/issues)
 
+
+<a href="https://profile-counter.glitch.me/khoih-prog/count.svg" title="Total khoih-prog Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog/count.svg" style="height: 30px;width: 200px;"></a>
+<a href="https://profile-counter.glitch.me/khoih-prog-ESPAsyncTCP/count.svg" title="Forked ESPAsyncTCP Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog-ESPAsyncTCP/count.svg" style="height: 30px;width: 200px;"></a>
+
 ---
 ---
 
@@ -21,6 +25,6 @@
 
 ### Release v1.3.0
 
-1. Initial modifications for ESP8266 boards, using WiFi or LwIP Ethernet, with [ESP8266 core v3.0.2+](https://github.com/esp8266/Arduino/releases/tag/3.0.2) or WiFi with [ESP8266 core v2.7.4](https://github.com/esp8266/Arduino/releases/tag/2.7.4) to avoid compile errors
+1. Initial modifications for ESP8266 boards, using WiFi or LwIP Ethernet, with [ESP8266 core v3.0.2+](https://github.com/esp8266/Arduino/releases/tag/3.0.2) or WiFi with [ESP8266 core v2.7.4-](https://github.com/esp8266/Arduino/releases/tag/2.7.4) to avoid compile errors
 
 

examples/ClientServer/Client/Client.ino

@@ -13,53 +13,50 @@ extern "C"
 
 static os_timer_t intervalTimer;
 
-static void replyToServer(void* arg) 
+static void replyToServer(void* arg)
 {
   AsyncClient* client = reinterpret_cast<AsyncClient*>(arg);
 
   // send reply
-  if (client->space() > 32 && client->canSend()) 
+  if (client->space() > 32 && client->canSend())
   {
     char message[32];
-    
+
     sprintf(message, "this is from %s", WiFi.localIP().toString().c_str());
     client->add(message, strlen(message));
     client->send();
   }
 }
 
 /* event callbacks */
-static void handleData(void* arg, AsyncClient* client, void *data, size_t len) 
+static void handleData(void* arg, AsyncClient* client, void *data, size_t len)
 {
-  (void) arg;
-  
   Serial.printf("\n data received from %s \n", client->remoteIP().toString().c_str());
   Serial.write((uint8_t*)data, len);
 
   os_timer_arm(&intervalTimer, 2000, true); // schedule for reply to server at next 2s
 }
 
-void onConnect(void* arg, AsyncClient* client) 
+void onConnect(void* arg, AsyncClient* client)
 {
-  (void) arg;
-  
   Serial.printf("\n client has been connected to %s on port %d \n", SERVER_HOST_NAME, TCP_PORT);
   replyToServer(client);
 }
 
 
-void setup() 
+void setup()
 {
   Serial.begin(115200);
+
   while (!Serial && millis() < 5000);
-  
+
   delay(200);
 
   // connects to access point
   WiFi.mode(WIFI_STA);
   WiFi.begin(SSID, PASSWORD);
-  
-  while (WiFi.status() != WL_CONNECTED) 
+
+  while (WiFi.status() != WL_CONNECTED)
   {
     Serial.print('.');
     delay(500);
@@ -74,6 +71,6 @@ void setup()
   os_timer_setfn(&intervalTimer, &replyToServer, client);
 }
 
-void loop() 
+void loop()
 {
 }

examples/ClientServer/Client/config.h

@@ -2,14 +2,14 @@
 #define CONFIG_H
 
 /*
- * This example demonstrate how to use asynchronous client & server APIs
- * in order to establish tcp socket connections in client server manner.
- * server is running (on port 7050) on one ESP, acts as AP, and other clients running on
- * remaining ESPs acts as STAs. after connection establishment between server and clients
- * there is a simple message transfer in every 2s. clients connect to server via it's host name
- * (in this case 'esp_server') with help of DNS service running on server side.
- *
- * Note: default MSS for ESPAsyncTCP is 536 byte and defualt ACK timeout is 5s.
+   This example demonstrate how to use asynchronous client & server APIs
+   in order to establish tcp socket connections in client server manner.
+   server is running (on port 7050) on one ESP, acts as AP, and other clients running on
+   remaining ESPs acts as STAs. after connection establishment between server and clients
+   there is a simple message transfer in every 2s. clients connect to server via it's host name
+   (in this case 'esp_server') with help of DNS service running on server side.
+
+   Note: default MSS for ESPAsyncTCP is 536 byte and defualt ACK timeout is 5s.
 */
 
 #define SSID "ESP-TEST"

examples/ClientServer/Server/Server.ino

@@ -12,87 +12,78 @@ static DNSServer DNS;
 
 static std::vector<AsyncClient*> clients; // a list to hold all clients
 
- /* clients events */
-static void handleError(void* arg, AsyncClient* client, int8_t error) 
+/* clients events */
+static void handleError(void* arg, AsyncClient* client, int8_t error)
 {
-  (void) arg;
-  
-	Serial.printf("\n connection error %s from client %s \n", client->errorToString(error), client->remoteIP().toString().c_str());
+  Serial.printf("\n connection error %s from client %s \n", client->errorToString(error),
+                client->remoteIP().toString().c_str());
 }
 
-static void handleData(void* arg, AsyncClient* client, void *data, size_t len) 
+static void handleData(void* arg, AsyncClient* client, void *data, size_t len)
 {
-  (void) arg;
-  
-	Serial.printf("\n data received from client %s \n", client->remoteIP().toString().c_str());
-	Serial.write((uint8_t*)data, len);
-
-	// reply to client
-	if (client->space() > 32 && client->canSend()) 
-	{
-		char reply[32];
-		sprintf(reply, "this is from %s", SERVER_HOST_NAME);
-		client->add(reply, strlen(reply));
-		client->send();
-	}
+  Serial.printf("\n data received from client %s \n", client->remoteIP().toString().c_str());
+  Serial.write((uint8_t*)data, len);
+
+  // reply to client
+  if (client->space() > 32 && client->canSend())
+  {
+    char reply[32];
+    sprintf(reply, "this is from %s", SERVER_HOST_NAME);
+    client->add(reply, strlen(reply));
+    client->send();
+  }
 }
 
-static void handleDisconnect(void* arg, AsyncClient* client) 
+static void handleDisconnect(void* arg, AsyncClient* client)
 {
-  (void) arg;
-  
-	Serial.printf("\n client %s disconnected \n", client->remoteIP().toString().c_str());
+  Serial.printf("\n client %s disconnected \n", client->remoteIP().toString().c_str());
 }
 
-static void handleTimeOut(void* arg, AsyncClient* client, uint32_t time) 
+static void handleTimeOut(void* arg, AsyncClient* client, uint32_t time)
 {
-  (void) arg;
-  (void) time;
-  
-	Serial.printf("\n client ACK timeout ip: %s \n", client->remoteIP().toString().c_str());
+  Serial.printf("\n client ACK timeout ip: %s \n", client->remoteIP().toString().c_str());
 }
 
 
 /* server events */
-static void handleNewClient(void* arg, AsyncClient* client) 
+static void handleNewClient(void* arg, AsyncClient* client)
 {
-  (void) arg;
-  
-	Serial.printf("\n new client has been connected to server, ip: %s", client->remoteIP().toString().c_str());
-
-	// add to list
-	clients.push_back(client);
-	
-	// register events
-	client->onData(&handleData, NULL);
-	client->onError(&handleError, NULL);
-	client->onDisconnect(&handleDisconnect, NULL);
-	client->onTimeout(&handleTimeOut, NULL);
+  Serial.printf("\n new client has been connected to server, ip: %s", client->remoteIP().toString().c_str());
+
+  // add to list
+  clients.push_back(client);
+
+  // register events
+  client->onData(&handleData, NULL);
+  client->onError(&handleError, NULL);
+  client->onDisconnect(&handleDisconnect, NULL);
+  client->onTimeout(&handleTimeOut, NULL);
 }
 
-void setup() 
+void setup()
 {
-	Serial.begin(115200);
+  Serial.begin(115200);
+
   while (!Serial && millis() < 5000);
- 
-	delay(200);
-	
-	// create access point
-	while (!WiFi.softAP(SSID, PASSWORD, 6, false, 15)) 
-	{
-		delay(500);
-	}
-
-	// start dns server
-	if (!DNS.start(DNS_PORT, SERVER_HOST_NAME, WiFi.softAPIP()))
-		Serial.printf("\n failed to start dns service \n");
-
-	AsyncServer* server = new AsyncServer(TCP_PORT); // start listening on tcp port 7050
-	server->onClient(&handleNewClient, server);
-	server->begin();
+
+  delay(200);
+
+  // create access point
+  while (!WiFi.softAP(SSID, PASSWORD, 6, false, 15))
+  {
+    delay(500);
+  }
+
+  // start dns server
+  if (!DNS.start(DNS_PORT, SERVER_HOST_NAME, WiFi.softAPIP()))
+    Serial.printf("\n failed to start dns service \n");
+
+  AsyncServer* server = new AsyncServer(TCP_PORT); // start listening on tcp port 7050
+  server->onClient(&handleNewClient, server);
+  server->begin();
 }
 
-void loop() 
+void loop()
 {
-	DNS.processNextRequest();
+  DNS.processNextRequest();
 }

examples/ClientServer/Server/config.h

@@ -2,14 +2,14 @@
 #define CONFIG_H
 
 /*
- * This example demonstrate how to use asynchronous client & server APIs
- * in order to establish tcp socket connections in client server manner.
- * server is running (on port 7050) on one ESP, acts as AP, and other clients running on
- * remaining ESPs acts as STAs. after connection establishment between server and clients
- * there is a simple message transfer in every 2s. clients connect to server via it's host name
- * (in this case 'esp_server') with help of DNS service running on server side.
- *
- * Note: default MSS for ESPAsyncTCP is 536 byte and defualt ACK timeout is 5s.
+   This example demonstrate how to use asynchronous client & server APIs
+   in order to establish tcp socket connections in client server manner.
+   server is running (on port 7050) on one ESP, acts as AP, and other clients running on
+   remaining ESPs acts as STAs. after connection establishment between server and clients
+   there is a simple message transfer in every 2s. clients connect to server via it's host name
+   (in this case 'esp_server') with help of DNS service running on server side.
+
+   Note: default MSS for ESPAsyncTCP is 536 byte and defualt ACK timeout is 5s.
 */
 
 #define SSID "ESP-TEST"