You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 21, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/index.md
+22-5Lines changed: 22 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,7 @@ This fork is based on https://github.com/yubox-node-org/ESPAsyncWebServer and in
15
15
- Deployed in PlatformIO registry and Arduino IDE library manager
16
16
- CI
17
17
- Only supports ESP32
18
+
- Resurrected `AsyncWebSocketMessageBuffer` and `makeBuffer()` in order to make the fork API-compatible with the original library from me-no-dev regarding WebSocket.
18
19
19
20
## Documentation
20
21
@@ -23,13 +24,29 @@ Please look at the original libraries for more examples and documentation.
## `AsyncWebSocketMessageBuffer` and `makeBuffer()`
27
28
28
-
The fork from yubox introduces some breaking API changes compared to the original library, especially regarding the use of `std::shared_ptr<std::vector<uint8_t>>` for WebSocket.
29
-
Thanks to this fork, you can handle them by using `ASYNCWEBSERVER_FORK_mathieucarbou`.
29
+
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.
30
30
31
-
Here is an example for serializing a Json document in a websocket message buffer directly.
32
-
This code is compatible with both forks.
31
+
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.
32
+
So you have the choice of which API to use.
33
+
I strongly suggest to use the optimized API from `yubox-node-org` as it is much more efficient.
34
+
35
+
Here is an example for serializing a Json document in a websocket message buffer. This code is compatible with any forks, but not optimized:
0 commit comments