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

31 lines
1.1 KiB
ReStructuredText

ASIO port
=========
Overview
--------
Asio is a cross-platform C++ library, see https://think-async.com. 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 and ssl.
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:`examples/protocols/asio`:
- :example:`examples/protocols/asio/udp_echo_server`
- :example:`examples/protocols/asio/tcp_echo_server`
- :example:`examples/protocols/asio/chat_client`
- :example:`examples/protocols/asio/chat_server`
Please refer to the specific example README.md for details