espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-04 13:14:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Added breaking change for esp_https_server to migration guide

Browse Source
This commit is contained in:
Harshit Malpani
2022-05-11 11:37:42 +05:30
parent 2c56c6cad8
commit 9f99d2350a
2 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
components/esp_https_server/include/esp_https_server.h
View File

@@ -160,7 +160,10 @@ esp_err_t httpd_ssl_start(httpd_handle_t *handle, httpd_ssl_config_t *config);
* Stop the server. Blocks until the server is shut down. * Stop the server. Blocks until the server is shut down.
* *
* @param[in] handle * @param[in] handle
* @return success * @return
* - ESP_OK: Server stopped successfully
* - ESP_ERR_INVALID_ARG: Invalid argument
* - ESP_FAIL: Failure to shut down server
*/ */
esp_err_t httpd_ssl_stop(httpd_handle_t handle); esp_err_t httpd_ssl_stop(httpd_handle_t handle);

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

@@ -86,6 +86,7 @@ Names of variables holding different certs in :cpp:type:`httpd_ssl_config_t` str
* :cpp:member:`httpd_ssl_config::cacert_pem` variable inherits role of `client_verify_cert_pem` variable * :cpp:member:`httpd_ssl_config::cacert_pem` variable inherits role of `client_verify_cert_pem` variable
* :cpp:member:`httpd_ssl_config::cacert_len` variable inherits role of `client_verify_cert_len` variable * :cpp:member:`httpd_ssl_config::cacert_len` variable inherits role of `client_verify_cert_len` variable
The return type of the :cpp:func:`httpd_ssl_stop` API has been changed to :cpp:type:`esp_err_t` from ``void``.
ESP HTTPS OTA ESP HTTPS OTA
-------------- --------------