forked from espressif/esp-idf
ASIO: Remove internal component, examples, test and docs
This commit is contained in:
@@ -1,42 +1,15 @@
|
||||
ASIO port
|
||||
=========
|
||||
|
||||
Overview
|
||||
--------
|
||||
Asio is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach.
|
||||
|
||||
The ESP-IDF component `ASIO` has been moved from ESP-IDF since version v5.0 to a separate repository:
|
||||
|
||||
ASIO documentation
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
Please refer to the original asio documentation at https://think-async.com/Asio/Documentation.
|
||||
Asio also comes with a number of examples which could be find under Documentation/Examples on that web site.
|
||||
* `ASIO component on GitHub <https://github.com/espressif/esp-protocols/components/asio>`__
|
||||
|
||||
Supported features
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
ESP platform port currently supports only network asynchronous socket operations; does not support serial port.
|
||||
SSL/TLS support is disabled by default and could be enabled in component configuration menu by choosing TLS library from
|
||||
Hosted Documentation
|
||||
--------------------
|
||||
|
||||
- mbedTLS with OpenSSL translation layer (default option)
|
||||
- wolfSSL
|
||||
The documentation can be found on the link below:
|
||||
|
||||
SSL support is very basic at this stage and it does include following features:
|
||||
|
||||
- Verification callbacks
|
||||
- DH property files
|
||||
- Certificates/private keys file APIs
|
||||
|
||||
Internal asio settings for ESP include
|
||||
|
||||
- EXCEPTIONS are enabled in ASIO if enabled in menuconfig
|
||||
- TYPEID is enabled in ASIO if enabled in menuconfig
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
ESP examples are based on standard asio :example:`protocols/asio`:
|
||||
|
||||
- :example:`protocols/asio/udp_echo_server`
|
||||
- :example:`protocols/asio/tcp_echo_server`
|
||||
- :example:`protocols/asio/asio_chat`
|
||||
- :example:`protocols/asio/ssl_client_server`
|
||||
|
||||
Please refer to the specific example README.md for details
|
||||
* `ASIO documentation (English) <https://espressif.github.io/esp-protocols/asio/index.html>`__
|
||||
|
||||
Reference in New Issue
Block a user