Skip to content

Commit f229a84

Browse files
committed
Merge branch 'contrib/github_pr_15968' into 'master'
docs(esp_http_client): update return codes for open & perform (GitHub PR) See merge request espressif/esp-idf!39239
2 parents 4b6b9c0 + a0f085d commit f229a84

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
@@ -291,6 +291,9 @@ esp_http_client_handle_t esp_http_client_init(const esp_http_client_config_t *co
291291
* @return
292292
* - ESP_OK on successful
293293
* - ESP_FAIL on error
294+
* - ESP_ERR_HTTP_CONNECTING is timed-out before connection is made
295+
* - ESP_ERR_HTTP_WRITE_DATA is timed-out before request fully sent
296+
* - ESP_ERR_HTTP_EAGAIN is timed-out before any data was ready
294297
*/
295298
esp_err_t esp_http_client_perform(esp_http_client_handle_t client);
296299

@@ -552,6 +555,7 @@ esp_err_t esp_http_client_delete_all_headers(esp_http_client_handle_t client);
552555
* @return
553556
* - ESP_OK
554557
* - ESP_FAIL
558+
* - ESP_ERR_HTTP_CONNECTING if timed-out before connection is made
555559
*/
556560
esp_err_t esp_http_client_open(esp_http_client_handle_t client, int write_len);
557561

0 commit comments

Comments
 (0)