Chapter 2. API Reference
int esp_http_client_write(esp_http_client_handle_t client, const char *buffer, int len)
This function will write data to the HTTP connection previously opened by esp_http_client_open()
Return
• (-1) if any errors
• Length of data written
Parameters
• [in] client: The esp_http_client handle
• buffer: The buffer
• [in] len: This value must not be larger than the write_len parameter provided to
esp_http_client_open()
int esp_http_client_fetch_headers(esp_http_client_handle_t client)
This function need to call after esp_http_client_open, it will read from http stream, process all receive headers.
Return
• (0) if stream doesn’t contain content-length header, or chunked encoding (checked by
esp_http_client_is_chunked response)
• (-1: ESP_FAIL) if any errors
• Download data length defined by content-length header
Parameters
• [in] client: The esp_http_client handle
bool esp_http_client_is_chunked_response(esp_http_client_handle_t client)
Check response data is chunked.
Return true or false
Parameters
• [in] client: The esp_http_client handle
int esp_http_client_read(esp_http_client_handle_t client, char *buffer, int len)
Read data from http stream.
Return
• (-1) if any errors
• Length of data was read
Parameters
• [in] client: The esp_http_client handle
• buffer: The buffer
• [in] len: The length
int esp_http_client_get_status_code(esp_http_client_handle_t client)
Get http response status code, the valid value if this function invoke after esp_http_client_perform
Return Status code
Parameters
• [in] client: The esp_http_client handle
int esp_http_client_get_content_length(esp_http_client_handle_t client)
Get http response content length (from header Content-Length) the valid value if this function invoke after
esp_http_client_perform
Return
• (-1) Chunked transfer
• Content-Length value as bytes
Parameters
• [in] client: The esp_http_client handle
esp_err_t esp_http_client_close(esp_http_client_handle_t client)
Close http connection, still kept all http request resources.
Return
• ESP_OK
• ESP_FAIL
Parameters
Espressif Systems 564
Submit Document Feedback
Release v4.4