Verze 3.6.0 z noveho repozitare https://github.com/ESP32Async/ESPAsyncWebServer
This commit is contained in:
151
README.md
151
README.md
@@ -1,32 +1,44 @@
|
||||
|
||||
|
||||
# ESPAsyncWebServer
|
||||
|
||||
[](https://GitHub.com/mathieucarbou/ESPAsyncWebServer/releases/)
|
||||
[](https://registry.platformio.org/libraries/mathieucarbou/ESPAsyncWebServer)
|
||||
[](https://GitHub.com/ESP32Async/ESPAsyncWebServer/releases/)
|
||||
[](https://registry.platformio.org/libraries/ESP32Async/ESPAsyncWebServer)
|
||||
|
||||
[](https://opensource.org/license/lgpl-3-0/)
|
||||
[](code_of_conduct.md)
|
||||
|
||||
[](https://github.com/mathieucarbou/ESPAsyncWebServer/actions/workflows/ci.yml)
|
||||
[](https://GitHub.com/mathieucarbou/ESPAsyncWebServer/commit/)
|
||||
[](https://gitpod.io/#https://github.com/mathieucarbou/ESPAsyncWebServer)
|
||||
[](https://github.com/ESP32Async/ESPAsyncWebServer/actions/workflows/ci.yml)
|
||||
[](https://GitHub.com/ESP32Async/ESPAsyncWebServer/commit/)
|
||||
[](https://gitpod.io/#https://github.com/ESP32Async/ESPAsyncWebServer)
|
||||
|
||||
Project moved to [ESP32Async](https://github.com/organizations/ESP32Async) organization at [https://github.com/ESP32Async/ESPAsyncWebServer](https://github.com/ESP32Async/ESPAsyncWebServer)
|
||||
|
||||
Discord Server: [https://discord.gg/X7zpGdyUcY](https://discord.gg/X7zpGdyUcY)
|
||||
|
||||
Please see the new links:
|
||||
|
||||
- `ESP32Async/ESPAsyncWebServer @ 3.6.0` (ESP32, ESP8266, RP2040)
|
||||
- `ESP32Async/AsyncTCP @ 3.3.2` (ESP32)
|
||||
- `ESP32Async/ESPAsyncTCP @ 2.0.0` (ESP8266)
|
||||
- `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip` (AsyncTCP alternative for ESP32)
|
||||
- `khoih-prog/AsyncTCP_RP2040W @ 1.2.0` (RP2040)
|
||||
|
||||
Asynchronous HTTP and WebSocket Server Library for ESP32, ESP8266 and RP2040
|
||||
Supports: WebSocket, SSE, Authentication, Arduino Json 7, File Upload, Static File serving, URL Rewrite, URL Redirect, etc.
|
||||
|
||||
This fork is based on [yubox-node-org/ESPAsyncWebServer](https://github.com/yubox-node-org/ESPAsyncWebServer) and includes all the concurrency fixes.
|
||||
|
||||
- [Changes in this fork](#changes-in-this-fork)
|
||||
- [Changes in this repository](#changes-in-this-repository)
|
||||
- [Dependencies](#dependencies)
|
||||
- [Performance](#performance)
|
||||
- [Important recommendations](#important-recommendations)
|
||||
- [Important recommendations for build options](#important-recommendations-for-build-options)
|
||||
- [`AsyncWebSocketMessageBuffer` and `makeBuffer()`](#asyncwebsocketmessagebuffer-and-makebuffer)
|
||||
- [How to replace a response](#how-to-replace-a-response)
|
||||
- [How to use Middleware](#how-to-use-middleware)
|
||||
- [How to use authentication with AuthenticationMiddleware](#how-to-use-authentication-with-authenticationmiddleware)
|
||||
- [How to use authentication with AsyncAuthenticationMiddleware](#how-to-use-authentication-with-authenticationmiddleware)
|
||||
- [Migration to Middleware to improve performance and memory usage](#migration-to-middleware-to-improve-performance-and-memory-usage)
|
||||
- [Original Documentation](#original-documentation)
|
||||
|
||||
## Changes in this fork
|
||||
## Changes in this repository
|
||||
|
||||
- (bug) A lot of bug fixes
|
||||
- (ci) Better CI with a complete matrix of Arduino versions and boards
|
||||
@@ -42,12 +54,13 @@ This fork is based on [yubox-node-org/ESPAsyncWebServer](https://github.com/yubo
|
||||
- (feat) **Resumable download** support using HEAD and bytes range
|
||||
- (feat) `StreamConcat` example to show how to stream multiple files in one response
|
||||
- (feat) Removed ESPIDF Editor (this is not the role of a web server library to do that - get the source files from the original repos if required)
|
||||
- (perf) [AsyncTCPSock](https://github.com/mathieucarbou/AsyncTCPSock) support: AsyncTCP can be ignored and AsyncTCPSock used instead
|
||||
- (perf) [AsyncTCPSock](https://github.com/ESP32Async/AsyncTCPSock) support: AsyncTCP can be ignored and AsyncTCPSock used instead
|
||||
- (perf) `char*` overloads to avoid using `String`
|
||||
- (perf) `DEFAULT_MAX_WS_CLIENTS` to change the number of allows WebSocket clients and use `cleanupClients()` to help cleanup resources about dead clients
|
||||
- (perf) `setCloseClientOnQueueFull(bool)` which can be set on a client to either close the connection or discard messages but not close the connection when the queue is full
|
||||
- (perf) `SSE_MAX_QUEUED_MESSAGES` to control the maximum number of messages that can be queued for a SSE client
|
||||
- (perf) `WS_MAX_QUEUED_MESSAGES`: control the maximum number of messages that can be queued for a Websocket client
|
||||
- (perf) in-flight buffer control and queue congestion avoidance to help to improve parallel connections handling, high volume data transfers and mitigate poor implemeneted slow user-code callbacks delayes on connctions handling
|
||||
- (perf) Code size improvements
|
||||
- (perf) Lot of code cleanup and optimizations
|
||||
- (perf) Performance improvements in terms of memory, speed and size
|
||||
@@ -56,37 +69,44 @@ This fork is based on [yubox-node-org/ESPAsyncWebServer](https://github.com/yubo
|
||||
|
||||
## WARNING: Important notes about future version 4.x
|
||||
|
||||
This ESPAsyncWebServer fork is now at version 3.x.
|
||||
This ESPAsyncWebServer fork is now at version 3.x, where we try to keep the API compatibility with original project as much as possible.
|
||||
|
||||
Next version 4.x will:
|
||||
We plan on creating a next major 4.x version that will:
|
||||
|
||||
1. Drop support for ESP8266, which goes EOL in a few years. All ESP8266 boards can be replaced by equivalent ESP32 boards.
|
||||
2. Drop support for Arduino 2.x and ESP-IDF 4.x. The library will be compatible with Arduino 3.x and ESP-IDF 5.x.
|
||||
3. Drop support for ArduinoJson 5.x and 6.x. The library will be compatible with ArduinoJson 7.x.
|
||||
1. Drop support for ESP8266, which goes EOL in a few years
|
||||
2. Drop support for Arduino 2.x and ESP-IDF 4.x. The library will be compatible with latest Arduino and ESP-IDF
|
||||
3. Drop support for ArduinoJson 5.x and 6.x. The library will be compatible with latest ArduinoJson
|
||||
|
||||
So if you need one of these feature, you will have to stick with 3.x or another fork.
|
||||
So if you need one of these feature, you will have to stick with the current 3.x.
|
||||
All releases we do will not cease to exist: all 3.x releases will stay in the release page.
|
||||
That is why we have tags and a release cycle.
|
||||
|
||||
Maintaining a library for ESP8266 and RP2040 has a real cost and clearly what we see is that most users helping are on ESP32.
|
||||
|
||||
If you are an ESP8266 user and want to help improve current 3.x, you are more than welcomed to contribute to this community effort.
|
||||
|
||||
## Dependencies
|
||||
|
||||
**WARNING** The library name was changed from `ESP Async WebServer` to `ESPAsyncWebServer` as per the Arduino Lint recommendations, but its name had to stay `ESP Async WebServer` in Arduino Registry.
|
||||
> [!WARNING]
|
||||
> The library name was changed from `ESP Async WebServer` to `ESPAsyncWebServer` as per the Arduino Lint recommendations, but its name had to stay `ESP Async WebServer` in Arduino Registry.
|
||||
|
||||
**PlatformIO / pioarduino:**
|
||||
|
||||
```ini
|
||||
lib_compat_mode = strict
|
||||
lib_ldf_mode = chain
|
||||
lib_deps = mathieucarbou/ESPAsyncWebServer @ 3.4.5
|
||||
lib_deps = ESP32Async/ESPAsyncWebServer @ 3.6.0
|
||||
```
|
||||
|
||||
**Dependencies:**
|
||||
|
||||
- **ESP32 with AsyncTCP**: `mathieucarbou/AsyncTCP @ 3.3.1`
|
||||
Arduino IDE: [https://github.com/mathieucarbou/AsyncTCP#v3.3.1](https://github.com/mathieucarbou/AsyncTCP/releases)
|
||||
- **ESP32 with AsyncTCP**: `ESP32Async/AsyncTCP @ 3.3.2`
|
||||
Arduino IDE: [https://github.com/ESP32Async/AsyncTCP#v3.3.2](https://github.com/ESP32Async/AsyncTCP/releases)
|
||||
|
||||
- **ESP32 with AsyncTCPSock**: `https://github.com/mathieucarbou/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip`
|
||||
- **ESP32 with AsyncTCPSock**: `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip`
|
||||
|
||||
- **ESP8266**: `esphome/ESPAsyncTCP-esphome @ 2.0.0`
|
||||
Arduino IDE: [https://github.com/mathieucarbou/esphome-ESPAsyncTCP#v2.0.0](https://github.com/mathieucarbou/esphome-ESPAsyncTCP/releases/tag/v2.0.0)
|
||||
- **ESP8266**: `ESP32Async/ESPAsyncTCP @ 2.0.0`
|
||||
Arduino IDE: [https://github.com/ESP32Async/ESPAsyncTCP#v2.0.0](https://github.com/ESP32Async/ESPAsyncTCP/releases/tag/v2.0.0)
|
||||
|
||||
- **RP2040**: `khoih-prog/AsyncTCP_RP2040W @ 1.2.0`
|
||||
Arduino IDE: [https://github.com/khoih-prog/AsyncTCP_RP2040W#v1.2.0](https://github.com/khoih-prog/AsyncTCP_RP2040W/releases/tag/v1.2.0)
|
||||
@@ -99,30 +119,30 @@ AsyncTCPSock can be used instead of AsyncTCP by excluding AsyncTCP from the libr
|
||||
lib_compat_mode = strict
|
||||
lib_ldf_mode = chain
|
||||
lib_deps =
|
||||
; mathieucarbou/AsyncTCP @ 3.3.1
|
||||
https://github.com/mathieucarbou/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip
|
||||
mathieucarbou/ESPAsyncWebServer @ 3.4.5
|
||||
; ESP32Async/AsyncTCP @ 3.3.2
|
||||
https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip
|
||||
ESP32Async/ESPAsyncWebServer @ 3.6.0
|
||||
lib_ignore =
|
||||
AsyncTCP
|
||||
mathieucarbou/AsyncTCP
|
||||
ESP32Async/AsyncTCP
|
||||
```
|
||||
|
||||
## Performance
|
||||
|
||||
Performance of `mathieucarbou/ESPAsyncWebServer @ 3.4.5`:
|
||||
Performance of `ESP32Async/ESPAsyncWebServer @ 3.6.0`:
|
||||
|
||||
```bash
|
||||
> brew install autocannon
|
||||
> autocannon -c 10 -w 10 -d 20 http://192.168.4.1
|
||||
```
|
||||
|
||||
With `mathieucarbou/AsyncTCP @ 3.3.1`
|
||||
With `ESP32Async/AsyncTCP @ 3.3.2`
|
||||
|
||||
[](https://mathieu.carbou.me/ESPAsyncWebServer/perf-c10.png)
|
||||
<img width="629" alt="perf-c10" src="https://github.com/user-attachments/assets/b4b7f953-c24d-4e04-8d87-ba3f26805737" />
|
||||
|
||||
With `https://github.com/mathieucarbou/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip`:
|
||||
With `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip`:
|
||||
|
||||
[](https://mathieu.carbou.me/ESPAsyncWebServer/perf-c10-asynctcpsock.png)
|
||||
<img width="654" alt="perf-c10-asynctcpsock" src="https://github.com/user-attachments/assets/0dacf133-ca47-40be-939b-e6f60fc95b81" />
|
||||
|
||||
**SSE performance**
|
||||
|
||||
@@ -158,26 +178,41 @@ Test is running for 20 seconds with 10 connections.
|
||||
// Total: 2038 events, 509.50 events / second
|
||||
```
|
||||
|
||||
## Important recommendations
|
||||
## Important recommendations for build options
|
||||
|
||||
Most of the crashes are caused by improper configuration of the library for the project.
|
||||
Here are some recommendations to avoid them.
|
||||
Most of the crashes are caused by improper use or configuration of the AsyncTCP library used for the project.
|
||||
Here are some recommendations to avoid them and build-time flags you can change.
|
||||
|
||||
`CONFIG_ASYNC_TCP_MAX_ACK_TIME` - defines a timeout for TCP connection to be considered alive when waiting for data.
|
||||
In some bad network conditions you might consider increasing it.
|
||||
|
||||
`CONFIG_ASYNC_TCP_QUEUE_SIZE` - defines the length of the queue for events related to connections handling.
|
||||
Both the server and AsyncTCP library in this fork were optimized to control the queue automatically. Do NOT try blindly increasing the queue size, it does not help you in a way you might think it is. If you receive debug messages about queue throttling, try to optimize your server callbaks code to execute as fast as possible.
|
||||
Read #165 thread, it might give you some hints.
|
||||
|
||||
`CONFIG_ASYNC_TCP_RUNNING_CORE` - CPU core thread affinity that runs the queue events handling and executes server callbacks. Default is ANY core, so it means that for dualcore SoCs both cores could handle server activities. If your server's code is too heavy and unoptimized or you see that sometimes
|
||||
server might affect other network activities, you might consider to bind it to the same core that runs Arduino code (1) to minimize affect on radio part. Otherwise you can leave the default to let RTOS decide where to run the thread based on priority
|
||||
|
||||
`CONFIG_ASYNC_TCP_STACK_SIZE` - stack size for the thread that runs sever events and callbacks. Default is 16k that is a way too much waste for well-defined short async code or simple static file handling. You might want to cosider reducing it to 4-8k to same RAM usage. If you do not know what this is or not sure about your callback code demands - leave it as default, should be enough even for very hungry callbacks in most cases.
|
||||
|
||||
> [!NOTE]
|
||||
> This relates to ESP32 only, ESP8266 uses different ESPAsyncTCP lib that does not has this build options
|
||||
|
||||
I personally use the following configuration in my projects:
|
||||
|
||||
```c++
|
||||
-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)
|
||||
-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 Arduino app (default is any core)
|
||||
-D CONFIG_ASYNC_TCP_STACK_SIZE=4096 // reduce the stack size (default is 16K)
|
||||
```
|
||||
|
||||
## `AsyncWebSocketMessageBuffer` and `makeBuffer()`
|
||||
|
||||
The fork from `yubox-node-org` introduces some breaking API changes compared to the original library, especially regarding the use of `std::shared_ptr<std::vector<uint8_t>>` for WebSocket.
|
||||
The fork from [yubox-node-org](https://github.com/yubox-node-org/ESPAsyncWebServer) introduces some breaking API changes compared to the original library, especially regarding the use of `std::shared_ptr<std::vector<uint8_t>>` for WebSocket.
|
||||
|
||||
This fork is compatible with the original library from `me-no-dev` regarding WebSocket, and wraps the optimizations done by `yubox-node-org` in the `AsyncWebSocketMessageBuffer` class.
|
||||
This fork is compatible with the original library from [me-no-dev](https://github.com/me-no-dev/ESPAsyncWebServer) regarding WebSocket, and wraps the optimizations done by `yubox-node-org` in the `AsyncWebSocketMessageBuffer` class.
|
||||
So you have the choice of which API to use.
|
||||
|
||||
Here are examples for serializing a Json document in a websocket message buffer:
|
||||
@@ -230,7 +265,7 @@ Middleware is a way to intercept requests to perform some operations on them, li
|
||||
Middleware can either be attached to individual handlers, attached at the server level (thus applied to all handlers), or both.
|
||||
They will be executed in the order they are attached, and they can stop the request processing by sending a response themselves.
|
||||
|
||||
You can have a look at the [SimpleServer.ino](https://github.com/mathieucarbou/ESPAsyncWebServer/blob/main/examples/SimpleServer/SimpleServer.ino) example for some use cases.
|
||||
You can have a look at the [SimpleServer.ino](https://github.com/ESP32Async/ESPAsyncWebServer/blob/main/examples/SimpleServer/SimpleServer.ino) example for some use cases.
|
||||
|
||||
For example, such middleware would handle authentication and set some attributes on the request to make them available for the next middleware and for the handler which will process the request.
|
||||
|
||||
@@ -253,24 +288,24 @@ AsyncMiddlewareFunction complexAuth([](AsyncWebServerRequest* request, ArMiddlew
|
||||
**Here are the list of available middlewares:**
|
||||
|
||||
- `AsyncMiddlewareFunction`: can convert a lambda function (`ArMiddlewareCallback`) to a middleware
|
||||
- `AuthenticationMiddleware`: to handle basic/digest authentication globally or per handler
|
||||
- `AuthorizationMiddleware`: to handle authorization globally or per handler
|
||||
- `CorsMiddleware`: to handle CORS preflight request globally or per handler
|
||||
- `HeaderFilterMiddleware`: to filter out headers from the request
|
||||
- `HeaderFreeMiddleware`: to only keep some headers from the request, and remove the others
|
||||
- `AsyncAuthenticationMiddleware`: to handle basic/digest authentication globally or per handler
|
||||
- `AsyncAuthorizationMiddleware`: to handle authorization globally or per handler
|
||||
- `AsyncCorsMiddleware`: to handle CORS preflight request globally or per handler
|
||||
- `AsyncHeaderFilterMiddleware`: to filter out headers from the request
|
||||
- `AsyncHeaderFreeMiddleware`: to only keep some headers from the request, and remove the others
|
||||
- `LoggerMiddleware`: to log requests globally or per handler with the same pattern as curl. Will also record request processing time
|
||||
- `RateLimitMiddleware`: to limit the number of requests on a windows of time globally or per handler
|
||||
- `AsyncRateLimitMiddleware`: to limit the number of requests on a windows of time globally or per handler
|
||||
|
||||
## How to use authentication with AuthenticationMiddleware
|
||||
## How to use authentication with AsyncAuthenticationMiddleware
|
||||
|
||||
Do not use the `setUsername()` and `setPassword()` methods on the hanlders anymore.
|
||||
They are deprecated.
|
||||
These methods were causing a copy of the username and password for each handler, which is not efficient.
|
||||
|
||||
Now, you can use the `AuthenticationMiddleware` to handle authentication globally or per handler.
|
||||
Now, you can use the `AsyncAuthenticationMiddleware` to handle authentication globally or per handler.
|
||||
|
||||
```c++
|
||||
AuthenticationMiddleware authMiddleware;
|
||||
AsyncAuthenticationMiddleware authMiddleware;
|
||||
|
||||
// [...]
|
||||
|
||||
@@ -292,14 +327,14 @@ myHandler.addMiddleware(&authMiddleware); // add authentication to a specific ha
|
||||
|
||||
## Migration to Middleware to improve performance and memory usage
|
||||
|
||||
- `AsyncEventSource.authorizeConnect(...)` => do not use this method anymore: add a common `AuthorizationMiddleware` to the handler or server, and make sure to add it AFTER the `AuthenticationMiddleware` if you use authentication.
|
||||
- `AsyncWebHandler.setAuthentication(...)` => do not use this method anymore: add a common `AuthenticationMiddleware` to the handler or server
|
||||
- `AsyncEventSource.authorizeConnect(...)` => do not use this method anymore: add a common `AsyncAuthorizationMiddleware` to the handler or server, and make sure to add it AFTER the `AsyncAuthenticationMiddleware` if you use authentication.
|
||||
- `AsyncWebHandler.setAuthentication(...)` => do not use this method anymore: add a common `AsyncAuthenticationMiddleware` to the handler or server
|
||||
- `ArUploadHandlerFunction` and `ArBodyHandlerFunction` => these callbacks receiving body data and upload and not calling anymore the authentication code for performance reasons.
|
||||
These callbacks can be called multiple times during request parsing, so this is up to the user to now call the `AuthenticationMiddleware.allowed(request)` if needed and ideally when the method is called for the first time.
|
||||
These callbacks can be called multiple times during request parsing, so this is up to the user to now call the `AsyncAuthenticationMiddleware.allowed(request)` if needed and ideally when the method is called for the first time.
|
||||
These callbacks are also not triggering the whole middleware chain since they are not part of the request processing workflow (they are not the final handler).
|
||||
|
||||
## Original Documentation
|
||||
|
||||
<!-- no toc -->
|
||||
- [Why should you care](#why-should-you-care)
|
||||
- [Important things to remember](#important-things-to-remember)
|
||||
- [Principles of operation](#principles-of-operation)
|
||||
|
||||
Reference in New Issue
Block a user