From a0f085d01206c3b9628c09db2340530196c66e2e Mon Sep 17 00:00:00 2001 From: Richard Allen Date: Fri, 16 May 2025 08:55:08 -0500 Subject: [PATCH] docs(esp_http_client): update return codes for open & perform Extend the return code section to include async return values. --- components/esp_http_client/include/esp_http_client.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/components/esp_http_client/include/esp_http_client.h b/components/esp_http_client/include/esp_http_client.h index 510b09889f..fb8e1e3a81 100644 --- a/components/esp_http_client/include/esp_http_client.h +++ b/components/esp_http_client/include/esp_http_client.h @@ -263,6 +263,9 @@ esp_http_client_handle_t esp_http_client_init(const esp_http_client_config_t *co * @return * - ESP_OK on successful * - ESP_FAIL on error + * - ESP_ERR_HTTP_CONNECTING is timed-out before connection is made + * - ESP_ERR_HTTP_WRITE_DATA is timed-out before request fully sent + * - ESP_ERR_HTTP_EAGAIN is timed-out before any data was ready */ esp_err_t esp_http_client_perform(esp_http_client_handle_t client); @@ -507,6 +510,7 @@ esp_err_t esp_http_client_delete_all_headers(esp_http_client_handle_t client); * @return * - ESP_OK * - ESP_FAIL + * - ESP_ERR_HTTP_CONNECTING if timed-out before connection is made */ esp_err_t esp_http_client_open(esp_http_client_handle_t client, int write_len);