espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2026-05-04 20:05:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Added breaking changes for ESP-TLS to migration guide

Browse Source
This commit is contained in:
Laukik Hase
2022-03-24 14:31:44 +05:30
parent 728a686b8a
commit 25b2092219
2 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/protocols/esp_tls.rst
+3 -1
View File
@@ -8,7 +8,9 @@ The ESP-TLS component provides a simplified API interface for accessing the comm
It supports common scenarios like CA certification validation, SNI, ALPN negotiation, non-blocking connection among others.
All the configuration can be specified in the ``esp_tls_cfg_t`` data structure. Once done, TLS communication can be conducted using the following APIs:
* :cpp:func:`esp_tls_conn_new`: for opening a new TLS connection.
* :cpp:func:`esp_tls_init`: for initializing the TLS connection handle.
* :cpp:func:`esp_tls_conn_new_sync`: for opening a new blocking TLS connection.
* :cpp:func:`esp_tls_conn_new_async`: for opening a new non-blocking TLS connection.
* :cpp:func:`esp_tls_conn_read`: for reading from the connection.
* :cpp:func:`esp_tls_conn_write`: for writing into the connection.
* :cpp:func:`esp_tls_conn_destroy`: for freeing up the connection.