esp_http_client.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632
  1. /*
  2. * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. */
  6. #ifndef _ESP_HTTP_CLIENT_H
  7. #define _ESP_HTTP_CLIENT_H
  8. #include "freertos/FreeRTOS.h"
  9. #include "sdkconfig.h"
  10. #include "esp_err.h"
  11. #include <sys/socket.h>
  12. #ifdef __cplusplus
  13. extern "C" {
  14. #endif
  15. #define DEFAULT_HTTP_BUF_SIZE (512)
  16. typedef struct esp_http_client *esp_http_client_handle_t;
  17. typedef struct esp_http_client_event *esp_http_client_event_handle_t;
  18. /**
  19. * @brief HTTP Client events id
  20. */
  21. typedef enum {
  22. HTTP_EVENT_ERROR = 0, /*!< This event occurs when there are any errors during execution */
  23. HTTP_EVENT_ON_CONNECTED, /*!< Once the HTTP has been connected to the server, no data exchange has been performed */
  24. HTTP_EVENT_HEADERS_SENT, /*!< After sending all the headers to the server */
  25. HTTP_EVENT_HEADER_SENT = HTTP_EVENT_HEADERS_SENT, /*!< This header has been kept for backward compatability
  26. and will be deprecated in future versions esp-idf */
  27. HTTP_EVENT_ON_HEADER, /*!< Occurs when receiving each header sent from the server */
  28. HTTP_EVENT_ON_DATA, /*!< Occurs when receiving data from the server, possibly multiple portions of the packet */
  29. HTTP_EVENT_ON_FINISH, /*!< Occurs when finish a HTTP session */
  30. HTTP_EVENT_DISCONNECTED, /*!< The connection has been disconnected */
  31. HTTP_EVENT_REDIRECT, /*!< Intercepting HTTP redirects to handle them manually */
  32. } esp_http_client_event_id_t;
  33. /**
  34. * @brief HTTP Client events data
  35. */
  36. typedef struct esp_http_client_event {
  37. esp_http_client_event_id_t event_id; /*!< event_id, to know the cause of the event */
  38. esp_http_client_handle_t client; /*!< esp_http_client_handle_t context */
  39. void *data; /*!< data of the event */
  40. int data_len; /*!< data length of data */
  41. void *user_data; /*!< user_data context, from esp_http_client_config_t user_data */
  42. char *header_key; /*!< For HTTP_EVENT_ON_HEADER event_id, it's store current http header key */
  43. char *header_value; /*!< For HTTP_EVENT_ON_HEADER event_id, it's store current http header value */
  44. } esp_http_client_event_t;
  45. /**
  46. * @brief HTTP Client transport
  47. */
  48. typedef enum {
  49. HTTP_TRANSPORT_UNKNOWN = 0x0, /*!< Unknown */
  50. HTTP_TRANSPORT_OVER_TCP, /*!< Transport over tcp */
  51. HTTP_TRANSPORT_OVER_SSL, /*!< Transport over ssl */
  52. } esp_http_client_transport_t;
  53. typedef esp_err_t (*http_event_handle_cb)(esp_http_client_event_t *evt);
  54. /**
  55. * @brief HTTP method
  56. */
  57. typedef enum {
  58. HTTP_METHOD_GET = 0, /*!< HTTP GET Method */
  59. HTTP_METHOD_POST, /*!< HTTP POST Method */
  60. HTTP_METHOD_PUT, /*!< HTTP PUT Method */
  61. HTTP_METHOD_PATCH, /*!< HTTP PATCH Method */
  62. HTTP_METHOD_DELETE, /*!< HTTP DELETE Method */
  63. HTTP_METHOD_HEAD, /*!< HTTP HEAD Method */
  64. HTTP_METHOD_NOTIFY, /*!< HTTP NOTIFY Method */
  65. HTTP_METHOD_SUBSCRIBE, /*!< HTTP SUBSCRIBE Method */
  66. HTTP_METHOD_UNSUBSCRIBE,/*!< HTTP UNSUBSCRIBE Method */
  67. HTTP_METHOD_OPTIONS, /*!< HTTP OPTIONS Method */
  68. HTTP_METHOD_COPY, /*!< HTTP COPY Method */
  69. HTTP_METHOD_MOVE, /*!< HTTP MOVE Method */
  70. HTTP_METHOD_LOCK, /*!< HTTP LOCK Method */
  71. HTTP_METHOD_UNLOCK, /*!< HTTP UNLOCK Method */
  72. HTTP_METHOD_PROPFIND, /*!< HTTP PROPFIND Method */
  73. HTTP_METHOD_PROPPATCH, /*!< HTTP PROPPATCH Method */
  74. HTTP_METHOD_MKCOL, /*!< HTTP MKCOL Method */
  75. HTTP_METHOD_MAX,
  76. } esp_http_client_method_t;
  77. /**
  78. * @brief HTTP Authentication type
  79. */
  80. typedef enum {
  81. HTTP_AUTH_TYPE_NONE = 0, /*!< No authention */
  82. HTTP_AUTH_TYPE_BASIC, /*!< HTTP Basic authentication */
  83. HTTP_AUTH_TYPE_DIGEST, /*!< HTTP Disgest authentication */
  84. } esp_http_client_auth_type_t;
  85. /**
  86. * @brief HTTP configuration
  87. */
  88. typedef struct {
  89. const char *url; /*!< HTTP URL, the information on the URL is most important, it overrides the other fields below, if any */
  90. const char *host; /*!< Domain or IP as string */
  91. int port; /*!< Port to connect, default depend on esp_http_client_transport_t (80 or 443) */
  92. const char *username; /*!< Using for Http authentication */
  93. const char *password; /*!< Using for Http authentication */
  94. esp_http_client_auth_type_t auth_type; /*!< Http authentication type, see `esp_http_client_auth_type_t` */
  95. const char *path; /*!< HTTP Path, if not set, default is `/` */
  96. const char *query; /*!< HTTP query */
  97. const char *cert_pem; /*!< SSL server certification, PEM format as string, if the client requires to verify server */
  98. size_t cert_len; /*!< Length of the buffer pointed to by cert_pem. May be 0 for null-terminated pem */
  99. const char *client_cert_pem; /*!< SSL client certification, PEM format as string, if the server requires to verify client */
  100. size_t client_cert_len; /*!< Length of the buffer pointed to by client_cert_pem. May be 0 for null-terminated pem */
  101. const char *client_key_pem; /*!< SSL client key, PEM format as string, if the server requires to verify client */
  102. size_t client_key_len; /*!< Length of the buffer pointed to by client_key_pem. May be 0 for null-terminated pem */
  103. const char *client_key_password; /*!< Client key decryption password string */
  104. size_t client_key_password_len; /*!< String length of the password pointed to by client_key_password */
  105. const char *user_agent; /*!< The User Agent string to send with HTTP requests */
  106. esp_http_client_method_t method; /*!< HTTP Method */
  107. int timeout_ms; /*!< Network timeout in milliseconds */
  108. bool disable_auto_redirect; /*!< Disable HTTP automatic redirects */
  109. int max_redirection_count; /*!< Max number of redirections on receiving HTTP redirect status code, using default value if zero*/
  110. int max_authorization_retries; /*!< Max connection retries on receiving HTTP unauthorized status code, using default value if zero. Disables authorization retry if -1*/
  111. http_event_handle_cb event_handler; /*!< HTTP Event Handle */
  112. esp_http_client_transport_t transport_type; /*!< HTTP transport type, see `esp_http_client_transport_t` */
  113. int buffer_size; /*!< HTTP receive buffer size */
  114. int buffer_size_tx; /*!< HTTP transmit buffer size */
  115. void *user_data; /*!< HTTP user_data context */
  116. bool is_async; /*!< Set asynchronous mode, only supported with HTTPS for now */
  117. bool use_global_ca_store; /*!< Use a global ca_store for all the connections in which this bool is set. */
  118. bool skip_cert_common_name_check; /*!< Skip any validation of server certificate CN field */
  119. const char *common_name; /*!< Pointer to the string containing server certificate common name.
  120. If non-NULL, server certificate CN must match this name,
  121. If NULL, server certificate CN must match hostname. */
  122. esp_err_t (*crt_bundle_attach)(void *conf); /*!< Function pointer to esp_crt_bundle_attach. Enables the use of certification
  123. bundle for server verification, must be enabled in menuconfig */
  124. bool keep_alive_enable; /*!< Enable keep-alive timeout */
  125. int keep_alive_idle; /*!< Keep-alive idle time. Default is 5 (second) */
  126. int keep_alive_interval; /*!< Keep-alive interval time. Default is 5 (second) */
  127. int keep_alive_count; /*!< Keep-alive packet retry send count. Default is 3 counts */
  128. struct ifreq *if_name; /*!< The name of interface for data to go through. Use the default interface without setting */
  129. #if CONFIG_ESP_TLS_USE_SECURE_ELEMENT
  130. bool use_secure_element; /*!< Enable this option to use secure element */
  131. #endif
  132. } esp_http_client_config_t;
  133. /**
  134. * Enum for the HTTP status codes.
  135. */
  136. typedef enum {
  137. /* 2xx - Success */
  138. HttpStatus_Ok = 200,
  139. /* 3xx - Redirection */
  140. HttpStatus_MultipleChoices = 300,
  141. HttpStatus_MovedPermanently = 301,
  142. HttpStatus_Found = 302,
  143. HttpStatus_SeeOther = 303,
  144. HttpStatus_TemporaryRedirect = 307,
  145. HttpStatus_PermanentRedirect = 308,
  146. /* 4xx - Client Error */
  147. HttpStatus_BadRequest = 400,
  148. HttpStatus_Unauthorized = 401,
  149. HttpStatus_Forbidden = 403,
  150. HttpStatus_NotFound = 404,
  151. /* 5xx - Server Error */
  152. HttpStatus_InternalError = 500
  153. } HttpStatus_Code;
  154. #define ESP_ERR_HTTP_BASE (0x7000) /*!< Starting number of HTTP error codes */
  155. #define ESP_ERR_HTTP_MAX_REDIRECT (ESP_ERR_HTTP_BASE + 1) /*!< The error exceeds the number of HTTP redirects */
  156. #define ESP_ERR_HTTP_CONNECT (ESP_ERR_HTTP_BASE + 2) /*!< Error open the HTTP connection */
  157. #define ESP_ERR_HTTP_WRITE_DATA (ESP_ERR_HTTP_BASE + 3) /*!< Error write HTTP data */
  158. #define ESP_ERR_HTTP_FETCH_HEADER (ESP_ERR_HTTP_BASE + 4) /*!< Error read HTTP header from server */
  159. #define ESP_ERR_HTTP_INVALID_TRANSPORT (ESP_ERR_HTTP_BASE + 5) /*!< There are no transport support for the input scheme */
  160. #define ESP_ERR_HTTP_CONNECTING (ESP_ERR_HTTP_BASE + 6) /*!< HTTP connection hasn't been established yet */
  161. #define ESP_ERR_HTTP_EAGAIN (ESP_ERR_HTTP_BASE + 7) /*!< Mapping of errno EAGAIN to esp_err_t */
  162. #define ESP_ERR_HTTP_CONNECTION_CLOSED (ESP_ERR_HTTP_BASE + 8) /*!< Read FIN from peer and the connection closed */
  163. /**
  164. * @brief Start a HTTP session
  165. * This function must be the first function to call,
  166. * and it returns a esp_http_client_handle_t that you must use as input to other functions in the interface.
  167. * This call MUST have a corresponding call to esp_http_client_cleanup when the operation is complete.
  168. *
  169. * @param[in] config The configurations, see `http_client_config_t`
  170. *
  171. * @return
  172. * - `esp_http_client_handle_t`
  173. * - NULL if any errors
  174. */
  175. esp_http_client_handle_t esp_http_client_init(const esp_http_client_config_t *config);
  176. /**
  177. * @brief Invoke this function after `esp_http_client_init` and all the options calls are made, and will perform the
  178. * transfer as described in the options. It must be called with the same esp_http_client_handle_t as input as the esp_http_client_init call returned.
  179. * esp_http_client_perform performs the entire request in either blocking or non-blocking manner. By default, the API performs request in a blocking manner and returns when done,
  180. * or if it failed, and in non-blocking manner, it returns if EAGAIN/EWOULDBLOCK or EINPROGRESS is encountered, or if it failed. And in case of non-blocking request,
  181. * the user may call this API multiple times unless request & response is complete or there is a failure. To enable non-blocking esp_http_client_perform(), `is_async` member of esp_http_client_config_t
  182. * must be set while making a call to esp_http_client_init() API.
  183. * You can do any amount of calls to esp_http_client_perform while using the same esp_http_client_handle_t. The underlying connection may be kept open if the server allows it.
  184. * If you intend to transfer more than one file, you are even encouraged to do so.
  185. * esp_http_client will then attempt to re-use the same connection for the following transfers, thus making the operations faster, less CPU intense and using less network resources.
  186. * Just note that you will have to use `esp_http_client_set_**` between the invokes to set options for the following esp_http_client_perform.
  187. *
  188. * @note You must never call this function simultaneously from two places using the same client handle.
  189. * Let the function return first before invoking it another time.
  190. * If you want parallel transfers, you must use several esp_http_client_handle_t.
  191. * This function include `esp_http_client_open` -> `esp_http_client_write` -> `esp_http_client_fetch_headers` -> `esp_http_client_read` (and option) `esp_http_client_close`.
  192. *
  193. * @param client The esp_http_client handle
  194. *
  195. * @return
  196. * - ESP_OK on successful
  197. * - ESP_FAIL on error
  198. */
  199. esp_err_t esp_http_client_perform(esp_http_client_handle_t client);
  200. /**
  201. * @brief Cancel an ongoing HTTP request. This API closes the current socket and opens a new socket with the same esp_http_client context.
  202. *
  203. * @param client The esp_http_client handle
  204. * @return
  205. * - ESP_OK on successful
  206. * - ESP_FAIL on error
  207. * - ESP_ERR_INVALID_ARG
  208. * - ESP_ERR_INVALID_STATE
  209. */
  210. esp_err_t esp_http_client_cancel_request(esp_http_client_handle_t client);
  211. /**
  212. * @brief Set URL for client, when performing this behavior, the options in the URL will replace the old ones
  213. *
  214. * @param[in] client The esp_http_client handle
  215. * @param[in] url The url
  216. *
  217. * @return
  218. * - ESP_OK
  219. * - ESP_FAIL
  220. */
  221. esp_err_t esp_http_client_set_url(esp_http_client_handle_t client, const char *url);
  222. /**
  223. * @brief Set post data, this function must be called before `esp_http_client_perform`.
  224. * Note: The data parameter passed to this function is a pointer and this function will not copy the data
  225. *
  226. * @param[in] client The esp_http_client handle
  227. * @param[in] data post data pointer
  228. * @param[in] len post length
  229. *
  230. * @return
  231. * - ESP_OK
  232. * - ESP_FAIL
  233. */
  234. esp_err_t esp_http_client_set_post_field(esp_http_client_handle_t client, const char *data, int len);
  235. /**
  236. * @brief Get current post field information
  237. *
  238. * @param[in] client The client
  239. * @param[out] data Point to post data pointer
  240. *
  241. * @return Size of post data
  242. */
  243. int esp_http_client_get_post_field(esp_http_client_handle_t client, char **data);
  244. /**
  245. * @brief Set http request header, this function must be called after esp_http_client_init and before any
  246. * perform function
  247. *
  248. * @param[in] client The esp_http_client handle
  249. * @param[in] key The header key
  250. * @param[in] value The header value
  251. *
  252. * @return
  253. * - ESP_OK
  254. * - ESP_FAIL
  255. */
  256. esp_err_t esp_http_client_set_header(esp_http_client_handle_t client, const char *key, const char *value);
  257. /**
  258. * @brief Get http request header.
  259. * The value parameter will be set to NULL if there is no header which is same as
  260. * the key specified, otherwise the address of header value will be assigned to value parameter.
  261. * This function must be called after `esp_http_client_init`.
  262. *
  263. * @param[in] client The esp_http_client handle
  264. * @param[in] key The header key
  265. * @param[out] value The header value
  266. *
  267. * @return
  268. * - ESP_OK
  269. * - ESP_FAIL
  270. */
  271. esp_err_t esp_http_client_get_header(esp_http_client_handle_t client, const char *key, char **value);
  272. /**
  273. * @brief Get http request username.
  274. * The address of username buffer will be assigned to value parameter.
  275. * This function must be called after `esp_http_client_init`.
  276. *
  277. * @param[in] client The esp_http_client handle
  278. * @param[out] value The username value
  279. *
  280. * @return
  281. * - ESP_OK
  282. * - ESP_ERR_INVALID_ARG
  283. */
  284. esp_err_t esp_http_client_get_username(esp_http_client_handle_t client, char **value);
  285. /**
  286. * @brief Set http request username.
  287. * The value of username parameter will be assigned to username buffer.
  288. * If the username parameter is NULL then username buffer will be freed.
  289. *
  290. * @param[in] client The esp_http_client handle
  291. * @param[in] username The username value
  292. *
  293. * @return
  294. * - ESP_OK
  295. * - ESP_ERR_INVALID_ARG
  296. */
  297. esp_err_t esp_http_client_set_username(esp_http_client_handle_t client, const char *username);
  298. /**
  299. * @brief Get http request password.
  300. * The address of password buffer will be assigned to value parameter.
  301. * This function must be called after `esp_http_client_init`.
  302. *
  303. * @param[in] client The esp_http_client handle
  304. * @param[out] value The password value
  305. *
  306. * @return
  307. * - ESP_OK
  308. * - ESP_ERR_INVALID_ARG
  309. */
  310. esp_err_t esp_http_client_get_password(esp_http_client_handle_t client, char **value);
  311. /**
  312. * @brief Set http request password.
  313. * The value of password parameter will be assigned to password buffer.
  314. * If the password parameter is NULL then password buffer will be freed.
  315. *
  316. * @param[in] client The esp_http_client handle
  317. * @param[in] password The password value
  318. *
  319. * @return
  320. * - ESP_OK
  321. * - ESP_ERR_INVALID_ARG
  322. */
  323. esp_err_t esp_http_client_set_password(esp_http_client_handle_t client, const char *password);
  324. /**
  325. * @brief Set http request auth_type.
  326. *
  327. * @param[in] client The esp_http_client handle
  328. * @param[in] auth_type The esp_http_client auth type
  329. *
  330. * @return
  331. * - ESP_OK
  332. * - ESP_ERR_INVALID_ARG
  333. */
  334. esp_err_t esp_http_client_set_authtype(esp_http_client_handle_t client, esp_http_client_auth_type_t auth_type);
  335. /**
  336. * @brief Get HTTP client session errno
  337. *
  338. * @param[in] client The esp_http_client handle
  339. *
  340. * @return
  341. * - (-1) if invalid argument
  342. * - errno
  343. */
  344. int esp_http_client_get_errno(esp_http_client_handle_t client);
  345. /**
  346. * @brief Set http request method
  347. *
  348. * @param[in] client The esp_http_client handle
  349. * @param[in] method The method
  350. *
  351. * @return
  352. * - ESP_OK
  353. * - ESP_ERR_INVALID_ARG
  354. */
  355. esp_err_t esp_http_client_set_method(esp_http_client_handle_t client, esp_http_client_method_t method);
  356. /**
  357. * @brief Set http request timeout
  358. *
  359. * @param[in] client The esp_http_client handle
  360. * @param[in] timeout_ms The timeout value
  361. *
  362. * @return
  363. * - ESP_OK
  364. * - ESP_ERR_INVALID_ARG
  365. */
  366. esp_err_t esp_http_client_set_timeout_ms(esp_http_client_handle_t client, int timeout_ms);
  367. /**
  368. * @brief Delete http request header
  369. *
  370. * @param[in] client The esp_http_client handle
  371. * @param[in] key The key
  372. *
  373. * @return
  374. * - ESP_OK
  375. * - ESP_FAIL
  376. */
  377. esp_err_t esp_http_client_delete_header(esp_http_client_handle_t client, const char *key);
  378. /**
  379. * @brief This function will be open the connection, write all header strings and return
  380. *
  381. * @param[in] client The esp_http_client handle
  382. * @param[in] write_len HTTP Content length need to write to the server
  383. *
  384. * @return
  385. * - ESP_OK
  386. * - ESP_FAIL
  387. */
  388. esp_err_t esp_http_client_open(esp_http_client_handle_t client, int write_len);
  389. /**
  390. * @brief This function will write data to the HTTP connection previously opened by esp_http_client_open()
  391. *
  392. * @param[in] client The esp_http_client handle
  393. * @param buffer The buffer
  394. * @param[in] len This value must not be larger than the write_len parameter provided to esp_http_client_open()
  395. *
  396. * @return
  397. * - (-1) if any errors
  398. * - Length of data written
  399. */
  400. int esp_http_client_write(esp_http_client_handle_t client, const char *buffer, int len);
  401. /**
  402. * @brief This function need to call after esp_http_client_open, it will read from http stream, process all receive headers
  403. *
  404. * @param[in] client The esp_http_client handle
  405. *
  406. * @return
  407. * - (0) if stream doesn't contain content-length header, or chunked encoding (checked by `esp_http_client_is_chunked` response)
  408. * - (-1: ESP_FAIL) if any errors
  409. * - (-ESP_ERR_HTTP_EAGAIN = -0x7007) if call is timed-out before any data was ready
  410. * - Download data length defined by content-length header
  411. */
  412. int64_t esp_http_client_fetch_headers(esp_http_client_handle_t client);
  413. /**
  414. * @brief Check response data is chunked
  415. *
  416. * @param[in] client The esp_http_client handle
  417. *
  418. * @return true or false
  419. */
  420. bool esp_http_client_is_chunked_response(esp_http_client_handle_t client);
  421. /**
  422. * @brief Read data from http stream
  423. *
  424. * @param[in] client The esp_http_client handle
  425. * @param buffer The buffer
  426. * @param[in] len The length
  427. *
  428. * @return
  429. * - (-1) if any errors
  430. * - Length of data was read
  431. *
  432. * @note (-ESP_ERR_HTTP_EAGAIN = -0x7007) is returned when call is timed-out before any data was ready
  433. */
  434. int esp_http_client_read(esp_http_client_handle_t client, char *buffer, int len);
  435. /**
  436. * @brief Get http response status code, the valid value if this function invoke after `esp_http_client_perform`
  437. *
  438. * @param[in] client The esp_http_client handle
  439. *
  440. * @return Status code
  441. */
  442. int esp_http_client_get_status_code(esp_http_client_handle_t client);
  443. /**
  444. * @brief Get http response content length (from header Content-Length)
  445. * the valid value if this function invoke after `esp_http_client_perform`
  446. *
  447. * @param[in] client The esp_http_client handle
  448. *
  449. * @return
  450. * - (-1) Chunked transfer
  451. * - Content-Length value as bytes
  452. */
  453. int64_t esp_http_client_get_content_length(esp_http_client_handle_t client);
  454. /**
  455. * @brief Close http connection, still kept all http request resources
  456. *
  457. * @param[in] client The esp_http_client handle
  458. *
  459. * @return
  460. * - ESP_OK
  461. * - ESP_FAIL
  462. */
  463. esp_err_t esp_http_client_close(esp_http_client_handle_t client);
  464. /**
  465. * @brief This function must be the last function to call for an session.
  466. * It is the opposite of the esp_http_client_init function and must be called with the same handle as input that a esp_http_client_init call returned.
  467. * This might close all connections this handle has used and possibly has kept open until now.
  468. * Don't call this function if you intend to transfer more files, re-using handles is a key to good performance with esp_http_client.
  469. *
  470. * @param[in] client The esp_http_client handle
  471. *
  472. * @return
  473. * - ESP_OK
  474. * - ESP_FAIL
  475. */
  476. esp_err_t esp_http_client_cleanup(esp_http_client_handle_t client);
  477. /**
  478. * @brief Get transport type
  479. *
  480. * @param[in] client The esp_http_client handle
  481. *
  482. * @return
  483. * - HTTP_TRANSPORT_UNKNOWN
  484. * - HTTP_TRANSPORT_OVER_TCP
  485. * - HTTP_TRANSPORT_OVER_SSL
  486. */
  487. esp_http_client_transport_t esp_http_client_get_transport_type(esp_http_client_handle_t client);
  488. /**
  489. * @brief Set redirection URL.
  490. * When received the 30x code from the server, the client stores the redirect URL provided by the server.
  491. * This function will set the current URL to redirect to enable client to execute the redirection request.
  492. *
  493. * @param[in] client The esp_http_client handle
  494. *
  495. * @return
  496. * - ESP_OK
  497. * - ESP_FAIL
  498. */
  499. esp_err_t esp_http_client_set_redirection(esp_http_client_handle_t client);
  500. /**
  501. * @brief On receiving HTTP Status code 401, this API can be invoked to add authorization
  502. * information.
  503. *
  504. * @note There is a possibility of receiving body message with redirection status codes, thus make sure
  505. * to flush off body data after calling this API.
  506. *
  507. * @param[in] client The esp_http_client handle
  508. */
  509. void esp_http_client_add_auth(esp_http_client_handle_t client);
  510. /**
  511. * @brief Checks if entire data in the response has been read without any error.
  512. *
  513. * @param[in] client The esp_http_client handle
  514. *
  515. * @return
  516. * - true
  517. * - false
  518. */
  519. bool esp_http_client_is_complete_data_received(esp_http_client_handle_t client);
  520. /**
  521. * @brief Helper API to read larger data chunks
  522. * This is a helper API which internally calls `esp_http_client_read` multiple times till the end of data is reached or till the buffer gets full.
  523. *
  524. * @param[in] client The esp_http_client handle
  525. * @param buffer The buffer
  526. * @param[in] len The buffer length
  527. *
  528. * @return
  529. * - Length of data was read
  530. */
  531. int esp_http_client_read_response(esp_http_client_handle_t client, char *buffer, int len);
  532. /**
  533. * @brief Process all remaining response data
  534. * This uses an internal buffer to repeatedly receive, parse, and discard response data until complete data is processed.
  535. * 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.
  536. *
  537. * @param[in] client The esp_http_client handle
  538. * @param len Length of data discarded
  539. *
  540. * @return
  541. * - ESP_OK If successful, len will have discarded length
  542. * - ESP_FAIL If failed to read response
  543. * - ESP_ERR_INVALID_ARG If the client is NULL
  544. */
  545. esp_err_t esp_http_client_flush_response(esp_http_client_handle_t client, int *len);
  546. /**
  547. * @brief Get URL from client
  548. *
  549. * @param[in] client The esp_http_client handle
  550. * @param[inout] url The buffer to store URL
  551. * @param[in] len The buffer length
  552. *
  553. * @return
  554. * - ESP_OK
  555. * - ESP_FAIL
  556. */
  557. esp_err_t esp_http_client_get_url(esp_http_client_handle_t client, char *url, const int len);
  558. /**
  559. * @brief Get Chunk-Length from client
  560. *
  561. * @param[in] client The esp_http_client handle
  562. * @param[out] len Variable to store length
  563. *
  564. * @return
  565. * - ESP_OK If successful, len will have length of current chunk
  566. * - ESP_FAIL If the server is not a chunked server
  567. * - ESP_ERR_INVALID_ARG If the client or len are NULL
  568. */
  569. esp_err_t esp_http_client_get_chunk_length(esp_http_client_handle_t client, int *len);
  570. #ifdef __cplusplus
  571. }
  572. #endif
  573. #endif