mirror of
https://github.com/espressif/esp-protocols.git
synced 2025-11-04 08:31:37 +01:00
25 lines
1.3 KiB
Markdown
25 lines
1.3 KiB
Markdown
|
# ESP32 libwebsockets Port
|
||
|
|
|
||
|
|
This is a lightweight port of the libwebsockets library designed to run on the ESP32. It provides WebSocket client functionalities.
|
||
|
|
|
||
|
|
## Supported Options
|
||
|
|
|
||
|
|
The ESP-IDF port of libwebsockets supports a set of common WebSocket configurations for clients. These options can be configured through a structure passed to the `lws_create_context()` function.
|
||
|
|
|
||
|
|
Key features supported:
|
||
|
|
- WebSocket with optional SSL/TLS
|
||
|
|
- HTTP/1.1 client support
|
||
|
|
|
||
|
|
## Memory Footprint Considerations
|
||
|
|
|
||
|
|
The memory consumption primarily depends on the number of concurrent connections and the selected options for WebSocket frames, protocol handling, and SSL/TLS features. It consumes approximately 300 kB of program memory.
|
||
|
|
|
||
|
|
### Client:
|
||
|
|
The values bellow were extracted from the client example (./examples/client/main/lws-client.c)
|
||
|
|
- **Initial Memory Usage**: ~8 kB of heap on startup
|
||
|
|
- **Connected Memory Usage Over TLS**: ~35.3 kB of heap after connected to a server
|
||
|
|
- **Connected Memory Usage Over TCP (Plain)**: ~4.5 kB of heap after connected to a server
|
||
|
|
|
||
|
|
#### When configuring a WebSocket client, ensure that you have enough heap space to handle the desired number of concurrent client connections.
|
||
|
|
#### SSL/TLS configurations may require additional memory overhead, depending on the certificate size and cryptographic settings.
|