esp-idf/docs/en/api-reference/protocols/asio.rst

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.


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
^^^^^^^^^^^^^^^^^^
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

- mbedTLS with OpenSSL translation layer (default option)
- wolfSSL

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: initial idf port of asio library without ssl 2018-05-29 11:25:24 +02:00			`ASIO port`
			`=========`

			`Overview`
			`--------`
docs: update redirected links 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 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. 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 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. 2020-06-05 16:17:01 +02:00
			`- mbedTLS with OpenSSL translation layer (default option)`
			`- wolfSSL`

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 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. 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 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 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 2018-05-29 11:25:24 +02:00
			`Application Example`
			`-------------------`
doc: fix broken example links 2020-01-20 21:06:06 +08:00			ESP examples are based on standard asio :example:`protocols/asio`:
asio: initial idf port of asio library without ssl 2018-05-29 11:25:24 +02:00
doc: fix broken example links 2020-01-20 21:06:06 +08:00			- :example:`protocols/asio/udp_echo_server`
			- :example:`protocols/asio/tcp_echo_server`
docs: update asio docs with new example paths after refactor. 2021-09-01 16:53:07 +08:00			- :example:`protocols/asio/asio_chat`
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. 2020-06-05 16:17:01 +02:00			- :example:`protocols/asio/ssl_client_server`
asio: initial idf port of asio library without ssl 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 2019-11-07 12:07:44 +01:00			`Please refer to the specific example README.md for details`