From 60dc4285f419e8222b4c3f627eff8d21f8e7b5cf Mon Sep 17 00:00:00 2001 From: Vikram Dattu Date: Tue, 17 Mar 2020 12:35:20 +0530 Subject: [PATCH] Fixed `esp_tls_conn_write` documentation. Return value `0` in actual is case of partial write and not error as per `mbedtls_ssl_write` Modified documentation of `esp_tls_conn_write` accordingly. Even `esp_wolfssl_write` API considers just negative returns as errors. Signed-off-by: Vikram Dattu --- components/esp-tls/esp_tls.h | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/components/esp-tls/esp_tls.h b/components/esp-tls/esp_tls.h index a5983b2e35..5d982d3dcc 100644 --- a/components/esp-tls/esp_tls.h +++ b/components/esp-tls/esp_tls.h @@ -433,10 +433,8 @@ int esp_tls_conn_http_new_async(const char *url, const esp_tls_cfg_t *cfg, esp_t * @param[in] datalen Length of data buffer. * * @return - * - >0 if write operation was successful, the return value is the number + * - >=0 if write operation was successful, the return value is the number * of bytes actually written to the TLS/SSL connection. - * - 0 if write operation was not successful. The underlying - * connection was closed. * - <0 if write operation was not successful, because either an * error occured or an action must be taken by the calling process. */