Chapter 2. API Reference
esp_err_t esp_http_client_flush_response(esp_http_client_handle_t client, int *len)
Process all remaining response data This uses an internal buffer to repeatedly receive, parse, and discard re-
sponse data until complete data is processed. As no additional user-supplied buffer is required, this may be
preferrable to esp_http_client_read_response in situations where the content of the response may
be ignored.
Return
• ESP_OK If successful, len will have discarded length
• ESP_FAIL If failed to read response
• ESP_ERR_INVALID_ARG If the client is NULL
Parameters
• [in] client: The esp_http_client handle
• len: Length of data discarded
esp_err_t esp_http_client_get_url(esp_http_client_handle_t client, char *url, const int len)
Get URL from client.
Return
• ESP_OK
• ESP_FAIL
Parameters
• [in] client: The esp_http_client handle
• [inout] url: The buffer to store URL
• [in] len: The buffer length
esp_err_t esp_http_client_get_chunk_length(esp_http_client_handle_t client, int *len)
Get Chunk-Length from client.
Return
• ESP_OK If successful, len will have length of current chunk
• ESP_FAIL If the server is not a chunked server
• ESP_ERR_INVALID_ARG If the client or len are NULL
Parameters
• [in] client: The esp_http_client handle
• [out] len: Variable to store length
Structures
struct esp_http_client_event
HTTP Client events data.
Public Members
esp_http_client_event_id_t event_id
event_id, to know the cause of the event
esp_http_client_handle_t client
esp_http_client_handle_t context
void *data
data of the event
int data_len
data length of data
void *user_data
user_data context, from esp_http_client_config_t user_data
char *header_key
For HTTP_EVENT_ON_HEADER event_id, it’s store current http header key
char *header_value
For HTTP_EVENT_ON_HEADER event_id, it’s store current http header value
Espressif Systems 566
Submit Document Feedback
Release v4.4
To Next Page
Loading...
Need help?
General