espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-06-25 17:31:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(asio): Updates asio docs

Browse Source 
- Removes mention to WolfSSL
- Fix links to examples
- Fix diagram markdwon.
This commit is contained in:
Euripedes Rocha
2023-10-31 09:24:38 +01:00
parent 425931a808
commit ce9337d332
2 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/asio/examples/async_request/README.md
View File

@ -25,6 +25,7 @@ The control of lifetime of the class, done by `std::shared_ptr` usage, guarantee
async operations until it's not needed any more. This makes necessary that all of the async operation class must start async operations until it's not needed any more. This makes necessary that all of the async operation class must start
its lifetime as a `std::shared_ptr` due to the usage of `std::enable_shared_from_this`. its lifetime as a `std::shared_ptr` due to the usage of `std::enable_shared_from_this`.
```
User creates a shared_ptr──┐ User creates a shared_ptr──┐
of AddressResolution and │ of AddressResolution and │
@ -47,6 +48,7 @@ its lifetime as a `std::shared_ptr` due to the usage of `std::enable_shared_from
is called. │ is called. │
└────►Completion Handler() └────►Completion Handler()
```
The previous diagram shows the process and the life span of each of the tasks in this examples. At each stage the The previous diagram shows the process and the life span of each of the tasks in this examples. At each stage the
object responsible for the last action inject itself to the completion handler of the next stage for reuse. object responsible for the last action inject itself to the completion handler of the next stage for reuse.

13
docs/asio/en/index.rst
View File

@ -17,7 +17,6 @@ ESP platform port currently supports only network asynchronous socket operations
SSL/TLS support is disabled by default and could be enabled in component configuration menu by choosing TLS library from SSL/TLS support is disabled by default and could be enabled in component configuration menu by choosing TLS library from
- mbedTLS with OpenSSL translation layer (default option) - mbedTLS with OpenSSL translation layer (default option)
- wolfSSL
SSL support is very basic at this stage and it does include following features: SSL support is very basic at this stage and it does include following features:
@ -32,11 +31,13 @@ Internal asio settings for ESP include
Application Example Application Example
------------------- -------------------
ESP examples are based on standard asio :example:`examples <../examples>`: ESP examples are based on standard asio :example:`examples <../../../components/asio/examples>`:
- :example:`udp_echo_server <../examples/udp_echo_server>` - :example:`asio_chat <../../../components/asio/examples/asio_chat>`
- :example:`tcp_echo_server <../examples/tcp_echo_server>` - :example:`async_request <../../../components/asio/examples/async_request>`
- :example:`asio_chat <../examples/asio_chat>` - :example:`socks4 <../../../components/asio/examples/socks4>`
- :example:`ssl_client_server <../examples/ssl_client_server>` - :example:`ssl_client_server <../../../components/asio/examples/ssl_client_server>`
- :example:`tcp_echo_server <../../../components/asio/examples/tcp_echo_server>`
- :example:`udp_echo_server <../../../components/asio/examples/udp_echo_server>`
Please refer to the specific example README.md for details Please refer to the specific example README.md for details