Updated recommended flags

mathieucarbou · Dec 11, 2024 · aed6b32 · aed6b32
1 parent 359cc68
commit aed6b32
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 118 deletions.
diff --git a/README.md b/README.md
@@ -133,57 +133,44 @@ Test is running for 20 seconds with 10 connections.
 ```
 // With AsyncTCP, with 10 workers: no message discarded from the queue
 //
-// Total: 1875 events, 468.75000000000000000000 events / second
-// Total: 1870 events, 467.50000000000000000000 events / second
-// Total: 1871 events, 467.75000000000000000000 events / second
-// Total: 1875 events, 468.75000000000000000000 events / second
-// Total: 1871 events, 467.75000000000000000000 events / second
-// Total: 1805 events, 451.25000000000000000000 events / second
-// Total: 1803 events, 450.75000000000000000000 events / second
-// Total: 1873 events, 468.25000000000000000000 events / second
-// Total: 1872 events, 468.00000000000000000000 events / second
-// Total: 1805 events, 451.25000000000000000000 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2120 events, 530.00 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2037 events, 509.25 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2120 events, 530.00 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2038 events, 509.50 events / second
 //
 // With AsyncTCPSock, with 10 workers: no message discarded from the queue
 //
-// Total: 1242 events, 310.50000000000000000000 events / second
-// Total: 1242 events, 310.50000000000000000000 events / second
-// Total: 1242 events, 310.50000000000000000000 events / second
-// Total: 1242 events, 310.50000000000000000000 events / second
-// Total: 1181 events, 295.25000000000000000000 events / second
-// Total: 1182 events, 295.50000000000000000000 events / second
-// Total: 1240 events, 310.00000000000000000000 events / second
-// Total: 1181 events, 295.25000000000000000000 events / second
-// Total: 1181 events, 295.25000000000000000000 events / second
-// Total: 1183 events, 295.75000000000000000000 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2120 events, 530.00 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2037 events, 509.25 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2120 events, 530.00 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2038 events, 509.50 events / second
 ```
 
 ## Important recommendations
 
 Most of the crashes are caused by improper configuration of the library for the project.
 Here are some recommendations to avoid them.
 
-1. Set the running core to be on the same core of your application (usually core 1) `-D CONFIG_ASYNC_TCP_RUNNING_CORE=1`
-2. Set the stack size appropriately with `-D CONFIG_ASYNC_TCP_STACK_SIZE=16384`.
-   The default value of `16384` might be too much for your project.
-   You can look at the [MycilaTaskMonitor](https://mathieu.carbou.me/MycilaTaskMonitor) project to monitor the stack usage.
-3. You can change **if you know what you are doing** the task priority with `-D CONFIG_ASYNC_TCP_PRIORITY=10`.
-   Default is `10`.
-4. You can increase the queue size with `-D CONFIG_ASYNC_TCP_QUEUE_SIZE=128`.
-   Default is `64`.
-5. You can decrease the maximum ack time `-D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000`.
-   Default is `5000`.
-
-I personally use the following configuration in my projects because my WS messages can be big (up to 4k).
-If you have smaller messages, you can increase `WS_MAX_QUEUED_MESSAGES` to 128.
+I personally use the following configuration in my projects:
 
 ```c++
-  -D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000
-  -D CONFIG_ASYNC_TCP_PRIORITY=10
-  -D CONFIG_ASYNC_TCP_QUEUE_SIZE=128
-  -D CONFIG_ASYNC_TCP_RUNNING_CORE=1
-  -D CONFIG_ASYNC_TCP_STACK_SIZE=4096
-  -D WS_MAX_QUEUED_MESSAGES=64
+  -D CONFIG_ASYNC_TCP_MAX_ACK_TIME=5000 // (keep default)
+  -D CONFIG_ASYNC_TCP_PRIORITY=10 // (keep default)
+  -D CONFIG_ASYNC_TCP_QUEUE_SIZE=64 // (keep default)
+  -D CONFIG_ASYNC_TCP_RUNNING_CORE=1 // force async_tcp task to be on same core as the app (default is core 0)
+  -D CONFIG_ASYNC_TCP_STACK_SIZE=4096 // reduce the stack size (default is 16K)
 ```
 
 ## `AsyncWebSocketMessageBuffer` and `makeBuffer()`

diff --git a/docs/index.md b/docs/index.md
@@ -133,57 +133,44 @@ Test is running for 20 seconds with 10 connections.
 ```
 // With AsyncTCP, with 10 workers: no message discarded from the queue
 //
-// Total: 1875 events, 468.75000000000000000000 events / second
-// Total: 1870 events, 467.50000000000000000000 events / second
-// Total: 1871 events, 467.75000000000000000000 events / second
-// Total: 1875 events, 468.75000000000000000000 events / second
-// Total: 1871 events, 467.75000000000000000000 events / second
-// Total: 1805 events, 451.25000000000000000000 events / second
-// Total: 1803 events, 450.75000000000000000000 events / second
-// Total: 1873 events, 468.25000000000000000000 events / second
-// Total: 1872 events, 468.00000000000000000000 events / second
-// Total: 1805 events, 451.25000000000000000000 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2120 events, 530.00 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2037 events, 509.25 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2120 events, 530.00 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2038 events, 509.50 events / second
 //
 // With AsyncTCPSock, with 10 workers: no message discarded from the queue
 //
-// Total: 1242 events, 310.50000000000000000000 events / second
-// Total: 1242 events, 310.50000000000000000000 events / second
-// Total: 1242 events, 310.50000000000000000000 events / second
-// Total: 1242 events, 310.50000000000000000000 events / second
-// Total: 1181 events, 295.25000000000000000000 events / second
-// Total: 1182 events, 295.50000000000000000000 events / second
-// Total: 1240 events, 310.00000000000000000000 events / second
-// Total: 1181 events, 295.25000000000000000000 events / second
-// Total: 1181 events, 295.25000000000000000000 events / second
-// Total: 1183 events, 295.75000000000000000000 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2120 events, 530.00 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2037 events, 509.25 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2119 events, 529.75 events / second
+// Total: 2120 events, 530.00 events / second
+// Total: 2038 events, 509.50 events / second
+// Total: 2038 events, 509.50 events / second
 ```
 
 ## Important recommendations
 
 Most of the crashes are caused by improper configuration of the library for the project.
 Here are some recommendations to avoid them.
 
-1. Set the running core to be on the same core of your application (usually core 1) `-D CONFIG_ASYNC_TCP_RUNNING_CORE=1`
-2. Set the stack size appropriately with `-D CONFIG_ASYNC_TCP_STACK_SIZE=16384`.
-   The default value of `16384` might be too much for your project.
-   You can look at the [MycilaTaskMonitor](https://mathieu.carbou.me/MycilaTaskMonitor) project to monitor the stack usage.
-3. You can change **if you know what you are doing** the task priority with `-D CONFIG_ASYNC_TCP_PRIORITY=10`.
-   Default is `10`.
-4. You can increase the queue size with `-D CONFIG_ASYNC_TCP_QUEUE_SIZE=128`.
-   Default is `64`.
-5. You can decrease the maximum ack time `-D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000`.
-   Default is `5000`.
-
-I personally use the following configuration in my projects because my WS messages can be big (up to 4k).
-If you have smaller messages, you can increase `WS_MAX_QUEUED_MESSAGES` to 128.
+I personally use the following configuration in my projects:
 
 ```c++
-  -D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000
-  -D CONFIG_ASYNC_TCP_PRIORITY=10
-  -D CONFIG_ASYNC_TCP_QUEUE_SIZE=128
-  -D CONFIG_ASYNC_TCP_RUNNING_CORE=1
-  -D CONFIG_ASYNC_TCP_STACK_SIZE=4096
-  -D WS_MAX_QUEUED_MESSAGES=64
+  -D CONFIG_ASYNC_TCP_MAX_ACK_TIME=5000 // (keep default)
+  -D CONFIG_ASYNC_TCP_PRIORITY=10 // (keep default)
+  -D CONFIG_ASYNC_TCP_QUEUE_SIZE=64 // (keep default)
+  -D CONFIG_ASYNC_TCP_RUNNING_CORE=1 // force async_tcp task to be on same core as the app (default is core 0)
+  -D CONFIG_ASYNC_TCP_STACK_SIZE=4096 // reduce the stack size (default is 16K)
 ```
 
 ## `AsyncWebSocketMessageBuffer` and `makeBuffer()`
@@ -622,7 +609,7 @@ Endpoints which consume JSON can use a special handler to get ready to use JSON
 #include "ArduinoJson.h"
 
 AsyncCallbackJsonWebHandler* handler = new AsyncCallbackJsonWebHandler("/rest/endpoint", [](AsyncWebServerRequest *request, JsonVariant &json) {
-  JsonObject& jsonObj = json.as<JsonObject>();
+  JsonObject jsonObj = json.as<JsonObject>();
   // ...
 });
 server.addHandler(handler);

diff --git a/examples/SimpleServer/SimpleServer.ino b/examples/SimpleServer/SimpleServer.ino
@@ -676,52 +676,51 @@ void setup() {
   // launch 16 concurrent workers for 30 seconds
   // > for i in {1..16}; do ( count=$(gtimeout 30 curl -s -N -H "Accept: text/event-stream" http://192.168.4.1/events 2>&1 | grep -c "^data:"); echo "Total: $count events, $(echo "$count / 4" | bc -l) events / second" ) & done;
   //
-  // With AsyncTCP, with 16 workers: a lot of Too many messages queued: deleting message
+  // With AsyncTCP, with 16 workers: a lot of "Event message queue overflow: discard message", no crash
   //
-  // Total: 119 events, 29.75000000000000000000 events / second
-  // Total: 727 events, 181.75000000000000000000 events / second
-  // Total: 1386 events, 346.50000000000000000000 events / second
-  // Total: 1385 events, 346.25000000000000000000 events / second
-  // Total: 1276 events, 319.00000000000000000000 events / second
-  // Total: 1411 events, 352.75000000000000000000 events / second
-  // Total: 1276 events, 319.00000000000000000000 events / second
-  // Total: 1333 events, 333.25000000000000000000 events / second
-  // Total: 1250 events, 312.50000000000000000000 events / second
-  // Total: 1275 events, 318.75000000000000000000 events / second
-  // Total: 1271 events, 317.75000000000000000000 events / second
-  // Total: 1271 events, 317.75000000000000000000 events / second
-  // Total: 1254 events, 313.50000000000000000000 events / second
-  // Total: 1251 events, 312.75000000000000000000 events / second
-  // Total: 1254 events, 313.50000000000000000000 events / second
-  // Total: 1262 events, 315.50000000000000000000 events / second
+  // Total: 1711 events, 427.75 events / second
+  // Total: 1711 events, 427.75 events / second
+  // Total: 1626 events, 406.50 events / second
+  // Total: 1562 events, 390.50 events / second
+  // Total: 1706 events, 426.50 events / second
+  // Total: 1659 events, 414.75 events / second
+  // Total: 1624 events, 406.00 events / second
+  // Total: 1706 events, 426.50 events / second
+  // Total: 1487 events, 371.75 events / second
+  // Total: 1573 events, 393.25 events / second
+  // Total: 1569 events, 392.25 events / second
+  // Total: 1559 events, 389.75 events / second
+  // Total: 1560 events, 390.00 events / second
+  // Total: 1562 events, 390.50 events / second
+  // Total: 1626 events, 406.50 events / second
   //
   // With AsyncTCP, with 10 workers:
   //
-  // Total: 1875 events, 468.75000000000000000000 events / second
-  // Total: 1870 events, 467.50000000000000000000 events / second
-  // Total: 1871 events, 467.75000000000000000000 events / second
-  // Total: 1875 events, 468.75000000000000000000 events / second
-  // Total: 1871 events, 467.75000000000000000000 events / second
-  // Total: 1805 events, 451.25000000000000000000 events / second
-  // Total: 1803 events, 450.75000000000000000000 events / second
-  // Total: 1873 events, 468.25000000000000000000 events / second
-  // Total: 1872 events, 468.00000000000000000000 events / second
-  // Total: 1805 events, 451.25000000000000000000 events / second
+  // Total: 2038 events, 509.50 events / second
+  // Total: 2120 events, 530.00 events / second
+  // Total: 2119 events, 529.75 events / second
+  // Total: 2038 events, 509.50 events / second
+  // Total: 2037 events, 509.25 events / second
+  // Total: 2119 events, 529.75 events / second
+  // Total: 2119 events, 529.75 events / second
+  // Total: 2120 events, 530.00 events / second
+  // Total: 2038 events, 509.50 events / second
+  // Total: 2038 events, 509.50 events / second
   //
   // With AsyncTCPSock, with 16 workers: ESP32 CRASH !!!
   //
   // With AsyncTCPSock, with 10 workers:
   //
-  // Total: 1242 events, 310.50000000000000000000 events / second
-  // Total: 1242 events, 310.50000000000000000000 events / second
-  // Total: 1242 events, 310.50000000000000000000 events / second
-  // Total: 1242 events, 310.50000000000000000000 events / second
-  // Total: 1181 events, 295.25000000000000000000 events / second
-  // Total: 1182 events, 295.50000000000000000000 events / second
-  // Total: 1240 events, 310.00000000000000000000 events / second
-  // Total: 1181 events, 295.25000000000000000000 events / second
-  // Total: 1181 events, 295.25000000000000000000 events / second
-  // Total: 1183 events, 295.75000000000000000000 events / second
+  // Total: 1242 events, 310.50 events / second
+  // Total: 1242 events, 310.50 events / second
+  // Total: 1242 events, 310.50 events / second
+  // Total: 1242 events, 310.50 events / second
+  // Total: 1181 events, 295.25 events / second
+  // Total: 1182 events, 295.50 events / second
+  // Total: 1240 events, 310.00 events / second
+  // Total: 1181 events, 295.25 events / second
+  // Total: 1181 events, 295.25 events / second
+  // Total: 1183 events, 295.75 events / second
   //
   server.addHandler(&events);
 

diff --git a/platformio.ini b/platformio.ini
@@ -16,9 +16,9 @@ build_flags =
   -Wno-unused-parameter
   -D CONFIG_ARDUHAL_LOG_COLORS
   -D CORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_VERBOSE
-  -D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000
+  -D CONFIG_ASYNC_TCP_MAX_ACK_TIME=5000
   -D CONFIG_ASYNC_TCP_PRIORITY=10
-  -D CONFIG_ASYNC_TCP_QUEUE_SIZE=128
+  -D CONFIG_ASYNC_TCP_QUEUE_SIZE=64
   -D CONFIG_ASYNC_TCP_RUNNING_CORE=1
   -D CONFIG_ASYNC_TCP_STACK_SIZE=4096
 upload_protocol = esptool