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

Merge branch 'contrib/github_pr_17652' into 'master'

Browse Source 
fix(esp_tls_conn_new_sync): Fix `esp_tls_conn_new_sync`'s doc to reflect its implementation (GitHub PR)

Closes IDFGH-16528 and IDFGH-16475

See merge request espressif/esp-idf!42263
This commit is contained in:
Ashish Sharma
2025-09-30 16:46:37 +08:00
parent af1ceb322f 2b42a6aa2b
commit 59f5bb4540
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] hostname Hostname of the host.
* @param[in] hostlen Length of hostname. * @param[in] hostlen Length of hostname.
* @param[in] port Port number of the host. * @param[in] port Port number of the host.
* @param[in] cfg TLS configuration as esp_tls_cfg_t. If you wish to open * @param[in] cfg TLS configuration as esp_tls_cfg_t. For a TLS
* non-TLS connection, keep this NULL. For TLS connection, * connection, pass a pointer to a esp_tls_cfg_t. For a
* a pass pointer to esp_tls_cfg_t. At a minimum, this * plain TCP connection, pass a pointer to a
* structure should be zero-initialized. * 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. * @param[in] tls Pointer to esp-tls as esp-tls handle.
* *
* @return * @return