blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-10 09:39:10 -04:00
Code Issues 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
No known key found for this signature in database
GPG Key ID: 11C571361F51A199
2 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/api-reference/protocols/esp_tls.rst
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.

21
docs/en/migration-guides/protocols.rst
View File

@ -93,4 +93,23 @@ ESP HTTPS OTA
Breaking Changes (Summary)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- The function :cpp:func:`esp_https_ota()` now requires pointer to :cpp:type:`esp_https_ota_config_t` as argument instead of pointer to :cpp:type:`esp_http_client_config_t`.
- The function :cpp:func:`esp_https_ota` now requires pointer to :cpp:type:`esp_https_ota_config_t` as argument instead of pointer to :cpp:type:`esp_http_client_config_t`.
ESP-TLS
--------------
Breaking Changes (Summary)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Following table summarizes the deprecated functions removed and their alternatives to be used from ESP-IDF v5.0 onwards.
+-----------------------------------+----------------------------------------+
| Function | Alternative |
+===================================+========================================+
| :cpp:func:`esp_tls_conn_new` | :cpp:func:`esp_tls_conn_new_sync` |
+-----------------------------------+----------------------------------------+
| :cpp:func:`esp_tls_conn_delete` | :cpp:func:`esp_tls_conn_destroy` |
+-----------------------------------+----------------------------------------+
- The function :cpp:func:`esp_tls_conn_http_new` has now been termed as deprecated. Please use the alternative function :cpp:func:`esp_tls_conn_http_new_sync` (or its asynchronous :cpp:func:`esp_tls_conn_http_new_async`). Note that the alternatives need an additional parameter :cpp:type:`esp_tls_t` which has to be initialized using the :cpp:func:`esp_tls_init` function.