From ce9337d332ee7b96c274635c601dfea4bf1739ca Mon Sep 17 00:00:00 2001 From: Euripedes Rocha Date: Tue, 31 Oct 2023 09:24:38 +0100 Subject: [PATCH] docs(asio): Updates asio docs - Removes mention to WolfSSL - Fix links to examples - Fix diagram markdwon. --- components/asio/examples/async_request/README.md | 2 ++ docs/asio/en/index.rst | 13 +++++++------ 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/components/asio/examples/async_request/README.md b/components/asio/examples/async_request/README.md index 3a9744978..c33c5d38f 100644 --- a/components/asio/examples/async_request/README.md +++ b/components/asio/examples/async_request/README.md @@ -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 its lifetime as a `std::shared_ptr` due to the usage of `std::enable_shared_from_this`. +``` User creates a shared_ptr──┐ 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. │ └────►Completion Handler() +``` 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. diff --git a/docs/asio/en/index.rst b/docs/asio/en/index.rst index 56ff694f2..1a8b926a9 100644 --- a/docs/asio/en/index.rst +++ b/docs/asio/en/index.rst @@ -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 - mbedTLS with OpenSSL translation layer (default option) -- wolfSSL 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 ------------------- -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:`tcp_echo_server <../examples/tcp_echo_server>` -- :example:`asio_chat <../examples/asio_chat>` -- :example:`ssl_client_server <../examples/ssl_client_server>` +- :example:`asio_chat <../../../components/asio/examples/asio_chat>` +- :example:`async_request <../../../components/asio/examples/async_request>` +- :example:`socks4 <../../../components/asio/examples/socks4>` +- :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