Symbols
loading...
Files
loading...
SummarySyntaxRelatedReferences

Fields

Field
Declared as
Description
HTTP Event Handle.
HTTP transport type, see `esp_http_client_transport_t`.
int
HTTP receive buffer size.
int
HTTP transmit buffer size.
void *
HTTP user_data context.
bool
Set asynchronous mode, only supported with HTTPS for now.
bool
Use a global ca_store for all the connections in which this bool is set.
bool
Skip any validation of server certificate CN field.
const char *
Pointer to the string containing server certificate common name. If non-NULL, server certificate CN must match this name, If NULL, server certificate CN must match hostname.
esp_err_t (*)(void *conf)
Function pointer to esp_crt_bundle_attach. Enables the use of certification bundle for server verification, must be enabled in menuconfig.
bool
Enable keep-alive timeout.
int
Keep-alive idle time. Default is 5 (second).
int
Keep-alive interval time. Default is 5 (second).
int
Keep-alive packet retry send count. Default is 3 counts.
struct ifreq *
The name of interface for data to go through. Use the default interface without setting.
const char *
HTTP URL, the information on the URL is most important, it overrides the other fields below, if any.
const char *
Domain or IP as string.
int
Port to connect, default depend on esp_http_client_transport_t (80 or 443).
const char *
Using for Http authentication.
const char *
Using for Http authentication.
Http authentication type, see `esp_http_client_auth_type_t`.
const char *
HTTP Path, if not set, default is `/`.
const char *
HTTP query.
const char *
SSL server certification, PEM format as string, if the client requires to verify server.
size_t
Length of the buffer pointed to by cert_pem. May be 0 for null-terminated pem.
const char *
SSL client certification, PEM format as string, if the server requires to verify client.
size_t
Length of the buffer pointed to by client_cert_pem. May be 0 for null-terminated pem.
const char *
SSL client key, PEM format as string, if the server requires to verify client.
size_t
Length of the buffer pointed to by client_key_pem. May be 0 for null-terminated pem.
const char *
Client key decryption password string.
size_t
String length of the password pointed to by client_key_password.
TLS protocol version of the connection, e.g., TLS 1.2, TLS 1.3 (default - no preference).
const char *
The User Agent string to send with HTTP requests.
HTTP Method.
int
Network timeout in milliseconds.
bool
Disable HTTP automatic redirects.
int
Max number of redirections on receiving HTTP redirect status code, using default value if zero.
int
Max connection retries on receiving HTTP unauthorized status code, using default value if zero. Disables authorization retry if -1.

References

from examples