Skip to content

Commit ce9337d

Browse files
docs(asio): Updates asio docs
- Removes mention to WolfSSL - Fix links to examples - Fix diagram markdwon.
1 parent 425931a commit ce9337d

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

components/asio/examples/async_request/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ The control of lifetime of the class, done by `std::shared_ptr` usage, guarantee
2525
async operations until it's not needed any more. This makes necessary that all of the async operation class must start
2626
its lifetime as a `std::shared_ptr` due to the usage of `std::enable_shared_from_this`.
2727

28+
```
2829
2930
User creates a shared_ptr──┐
3031
of AddressResolution and │
@@ -47,6 +48,7 @@ its lifetime as a `std::shared_ptr` due to the usage of `std::enable_shared_from
4748
is called. │
4849
└────►Completion Handler()
4950
51+
```
5052

5153
The previous diagram shows the process and the life span of each of the tasks in this examples. At each stage the
5254
object responsible for the last action inject itself to the completion handler of the next stage for reuse.

docs/asio/en/index.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ ESP platform port currently supports only network asynchronous socket operations
1717
SSL/TLS support is disabled by default and could be enabled in component configuration menu by choosing TLS library from
1818

1919
- mbedTLS with OpenSSL translation layer (default option)
20-
- wolfSSL
2120

2221
SSL support is very basic at this stage and it does include following features:
2322

@@ -32,11 +31,13 @@ Internal asio settings for ESP include
3231

3332
Application Example
3433
-------------------
35-
ESP examples are based on standard asio :example:`examples <../examples>`:
36-
37-
- :example:`udp_echo_server <../examples/udp_echo_server>`
38-
- :example:`tcp_echo_server <../examples/tcp_echo_server>`
39-
- :example:`asio_chat <../examples/asio_chat>`
40-
- :example:`ssl_client_server <../examples/ssl_client_server>`
34+
ESP examples are based on standard asio :example:`examples <../../../components/asio/examples>`:
35+
36+
- :example:`asio_chat <../../../components/asio/examples/asio_chat>`
37+
- :example:`async_request <../../../components/asio/examples/async_request>`
38+
- :example:`socks4 <../../../components/asio/examples/socks4>`
39+
- :example:`ssl_client_server <../../../components/asio/examples/ssl_client_server>`
40+
- :example:`tcp_echo_server <../../../components/asio/examples/tcp_echo_server>`
41+
- :example:`udp_echo_server <../../../components/asio/examples/udp_echo_server>`
4142

4243
Please refer to the specific example README.md for details

0 commit comments

Comments
 (0)