Skip to content

Commit a0f085d

Browse files
docs(esp_http_client): update return codes for open & perform
Extend the return code section to include async return values.
1 parent 6e5a178 commit a0f085d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

components/esp_http_client/include/esp_http_client.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,9 @@ esp_http_client_handle_t esp_http_client_init(const esp_http_client_config_t *co
263263
* @return
264264
* - ESP_OK on successful
265265
* - ESP_FAIL on error
266+
* - ESP_ERR_HTTP_CONNECTING is timed-out before connection is made
267+
* - ESP_ERR_HTTP_WRITE_DATA is timed-out before request fully sent
268+
* - ESP_ERR_HTTP_EAGAIN is timed-out before any data was ready
266269
*/
267270
esp_err_t esp_http_client_perform(esp_http_client_handle_t client);
268271

@@ -507,6 +510,7 @@ esp_err_t esp_http_client_delete_all_headers(esp_http_client_handle_t client);
507510
* @return
508511
* - ESP_OK
509512
* - ESP_FAIL
513+
* - ESP_ERR_HTTP_CONNECTING if timed-out before connection is made
510514
*/
511515
esp_err_t esp_http_client_open(esp_http_client_handle_t client, int write_len);
512516

0 commit comments

Comments
 (0)