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

esp-tls: Fix documentaion issue in esp_tls_conn_new_async API

Browse Source 
Closes https://github.com/espressif/esp-idf/issues/2576
This commit is contained in:
Jitin George
2018-10-23 13:11:03 +05:30
committed by bot
parent 822de0d038
commit e37aba0d93
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -138,7 +138,7 @@ esp_tls_t *esp_tls_conn_new(const char *hostname, int hostlen, int port, const e
*/ */
esp_tls_t *esp_tls_conn_http_new(const char *url, const esp_tls_cfg_t *cfg); esp_tls_t *esp_tls_conn_http_new(const char *url, const esp_tls_cfg_t *cfg);
/* /**
* @brief Create a new non-blocking TLS/SSL connection * @brief Create a new non-blocking TLS/SSL connection
* *
* This function initiates a non-blocking TLS/SSL connection with the specified host, but due to * This function initiates a non-blocking TLS/SSL connection with the specified host, but due to
@@ -151,9 +151,10 @@ esp_tls_t *esp_tls_conn_http_new(const char *url, const esp_tls_cfg_t *cfg);
* this structure should be set to be true. * this structure should be set to be true.
* @param[in] tls pointer to esp-tls as esp-tls handle. * @param[in] tls pointer to esp-tls as esp-tls handle.
* *
* @return - 1 If connection establishment fails. * @return
* - 0 If connection establishment is in progress. * - -1 If connection establishment fails.
* - 1 If connection establishment is successful. * - 0 If connection establishment is in progress.
* - 1 If connection establishment is successful.
*/ */
int esp_tls_conn_new_async(const char *hostname, int hostlen, int port, const esp_tls_cfg_t *cfg, esp_tls_t *tls); int esp_tls_conn_new_async(const char *hostname, int hostlen, int port, const esp_tls_cfg_t *cfg, esp_tls_t *tls);
@@ -163,12 +164,13 @@ int esp_tls_conn_new_async(const char *hostname, int hostlen, int port, const es
* The behaviour is same as esp_tls_conn_new() API. However this API accepts host's url. * The behaviour is same as esp_tls_conn_new() API. However this API accepts host's url.
* *
* @param[in] url url of host. * @param[in] url url of host.
* @param[in] tls pointer to esp-tls as esp-tls handle.
* @param[in] cfg TLS configuration as esp_tls_cfg_t. * @param[in] cfg TLS configuration as esp_tls_cfg_t.
* @param[in] tls pointer to esp-tls as esp-tls handle.
* *
* @return - 1 If connection establishment fails. * @return
* - 0 If connection establishment is in progress. * - -1 If connection establishment fails.
* - 1 If connection establishment is successful. * - 0 If connection establishment is in progress.
* - 1 If connection establishment is successful.
*/ */
int esp_tls_conn_http_new_async(const char *url, const esp_tls_cfg_t *cfg, esp_tls_t *tls); int esp_tls_conn_http_new_async(const char *url, const esp_tls_cfg_t *cfg, esp_tls_t *tls);