espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-07-18 13:02:21 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
b6bbe47cae12ec2f9534b64e59fe9b2a3d45bce8
esp-protocols/docs/asio/en/index.rst

44 lines
1.7 KiB
ReStructuredText
Raw Normal View History

asio: initial idf port of asio library without ssl * Original commit: espressif/esp-idf@1ef13c524c484e9fb62e6c0b11482c30c5383728
2018-05-29 11:25:24 +02:00
ASIO port
=========
Overview
--------
docs: update redirected links * Original commit: espressif/esp-idf@030cb77597eccf2a0d5f5bf6c9d5c58bf4110bd7
2022-04-28 14:34:20 +08:00
Asio is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach.
asio: initial idf port of asio library without ssl * Original commit: espressif/esp-idf@1ef13c524c484e9fb62e6c0b11482c30c5383728
2018-05-29 11:25:24 +02:00
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.
Supported features
^^^^^^^^^^^^^^^^^^
asio: Basic SSL/TLS support in asio port for ESP platform This port employs IDF port of OpenSSL for most common features, others are discouraged or not supported. The port also introduces several stubs for OpenSSL functions which ASIO needs to get compiled and linked. Upstream ASIO supports WolfSSL as SSL/TLS stack, as well, which is another option for SSL support in ASIO on ESP platform. * Original commit: espressif/esp-idf@9459c0dd432fdd0fccb49ea65bb5c72d1849e1ba
2020-06-05 16:17:01 +02:00
ESP platform port currently supports only network asynchronous socket operations; does not support serial port.
asio: option to use wolfSSL as TLS stack for ASIO Plus other minor update, make openssl aware of current modes (SSL_set_mode) Update coding style in examples and tests, including copyright notices * Original commit: espressif/esp-idf@1c8171c3e8d5a67e47dc8d6abac27ad2989470c3
2020-06-05 17:17:55 +02:00
SSL/TLS support is disabled by default and could be enabled in component configuration menu by choosing TLS library from
asio: Basic SSL/TLS support in asio port for ESP platform This port employs IDF port of OpenSSL for most common features, others are discouraged or not supported. The port also introduces several stubs for OpenSSL functions which ASIO needs to get compiled and linked. Upstream ASIO supports WolfSSL as SSL/TLS stack, as well, which is another option for SSL support in ASIO on ESP platform. * Original commit: espressif/esp-idf@9459c0dd432fdd0fccb49ea65bb5c72d1849e1ba
2020-06-05 16:17:01 +02:00
- mbedTLS with OpenSSL translation layer (default option)
asio: option to use wolfSSL as TLS stack for ASIO Plus other minor update, make openssl aware of current modes (SSL_set_mode) Update coding style in examples and tests, including copyright notices * Original commit: espressif/esp-idf@1c8171c3e8d5a67e47dc8d6abac27ad2989470c3
2020-06-05 17:17:55 +02:00
SSL support is very basic at this stage and it does include following features:
asio: Basic SSL/TLS support in asio port for ESP platform This port employs IDF port of OpenSSL for most common features, others are discouraged or not supported. The port also introduces several stubs for OpenSSL functions which ASIO needs to get compiled and linked. Upstream ASIO supports WolfSSL as SSL/TLS stack, as well, which is another option for SSL support in ASIO on ESP platform. * Original commit: espressif/esp-idf@9459c0dd432fdd0fccb49ea65bb5c72d1849e1ba
2020-06-05 16:17:01 +02:00
- Verification callbacks
- DH property files
- Certificates/private keys file APIs
asio: initial idf port of asio library without ssl * Original commit: espressif/esp-idf@1ef13c524c484e9fb62e6c0b11482c30c5383728
2018-05-29 11:25:24 +02:00
Internal asio settings for ESP include
asio: updated ASIO port to use latest asio and esp-idf features closes https://github.com/espressif/esp-idf/issues/4296 * Original commit: espressif/esp-idf@13d603e486624380d49f2e89614b10425c208d14
2019-11-07 12:07:44 +01:00
- EXCEPTIONS are enabled in ASIO if enabled in menuconfig
- TYPEID is enabled in ASIO if enabled in menuconfig
asio: initial idf port of asio library without ssl * Original commit: espressif/esp-idf@1ef13c524c484e9fb62e6c0b11482c30c5383728
2018-05-29 11:25:24 +02:00
Application Example
-------------------
docs(asio): Updates asio docs - Removes mention to WolfSSL - Fix links to examples - Fix diagram markdwon.
2023-10-31 09:24:38 +01:00
ESP examples are based on standard asio :example:`examples <../../../components/asio/examples>`:
- :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>`
asio: initial idf port of asio library without ssl * Original commit: espressif/esp-idf@1ef13c524c484e9fb62e6c0b11482c30c5383728
2018-05-29 11:25:24 +02:00
asio: updated ASIO port to use latest asio and esp-idf features closes https://github.com/espressif/esp-idf/issues/4296 * Original commit: espressif/esp-idf@13d603e486624380d49f2e89614b10425c208d14
2019-11-07 12:07:44 +01:00
Please refer to the specific example README.md for details
Reference in New Issue Copy Permalink