espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-10-02 18:10:57 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix(esp_tls_conn_new_sync): Fix esp_tls_conn_new_sync's doc to reflect its implementation

Browse Source 
Closes https://github.com/espressif/esp-idf/pull/17652
Closes https://github.com/espressif/esp-idf/issues/17598
This commit is contained in:
Jared Pon
2025-09-24 14:38:19 +00:00
committed by Ashish Sharma
parent b7deee951e
commit 2b42a6aa2b
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
components/esp-tls/esp_tls.h
View File

@@ -412,10 +412,12 @@ esp_tls_t *esp_tls_init(void);
* @param[in] hostname Hostname of the host.
* @param[in] hostlen Length of hostname.
* @param[in] port Port number of the host.
* @param[in] cfg TLS configuration as esp_tls_cfg_t. If you wish to open
* non-TLS connection, keep this NULL. For TLS connection,
* a pass pointer to esp_tls_cfg_t. At a minimum, this
* structure should be zero-initialized.
* @param[in] cfg TLS configuration as esp_tls_cfg_t. For a TLS
* connection, pass a pointer to a esp_tls_cfg_t. For a
* plain TCP connection, pass a pointer to a
* esp_tls_cfg_t with is_plain_tcp set to true. At a
* minimum, this pointer should be not NULL and the
* structure should be zero-initialized
* @param[in] tls Pointer to esp-tls as esp-tls handle.
*
* @return