Chapter 2. API Reference
HTTPD_TYPE_OCTET
HTTP Content type octext-stream
HTTPD_DEFAULT_CONFIG()
ESP_ERR_HTTPD_BASE
Starting number of HTTPD error codes
ESP_ERR_HTTPD_HANDLERS_FULL
All slots for registering URI handlers have been consumed
ESP_ERR_HTTPD_HANDLER_EXISTS
URI handler with same method and target URI already registered
ESP_ERR_HTTPD_INVALID_REQ
Invalid request pointer
ESP_ERR_HTTPD_RESULT_TRUNC
Result string truncated
ESP_ERR_HTTPD_RESP_HDR
Response header field larger than supported
ESP_ERR_HTTPD_RESP_SEND
Error occured while sending response packet
ESP_ERR_HTTPD_ALLOC_MEM
Failed to dynamically allocate memory for resource
ESP_ERR_HTTPD_TASK
Failed to launch server task/thread
HTTPD_RESP_USE_STRLEN
Type Definitions
typedef struct httpd_req httpd_req_t
HTTP Request Data Structure.
typedef struct httpd_uri httpd_uri_t
Structure for URI handler.
typedef int (*httpd_send_func_t)(httpd_handle_t hd, int sockfd, const char *buf, size_t buf_len,
int flags)
Prototype for HTTPDs low-level send function.
Note User specified send function must handle errors internally, depending upon the set value of errno,
and return specific HTTPD_SOCK_ERR_ codes, which will eventually be conveyed as return value
of httpd_send() function
Return
• Bytes : The number of bytes sent successfully
• HTTPD_SOCK_ERR_INVALID : Invalid arguments
• HTTPD_SOCK_ERR_TIMEOUT : Timeout/interrupted while calling socket send()
• HTTPD_SOCK_ERR_FAIL : Unrecoverable error while calling socket send()
Parameters
• [in] hd: server instance
• [in] sockfd: session socket file descriptor
• [in] buf: buffer with bytes to send
• [in] buf_len: data size
• [in] flags: flags for the send() function
typedef int (*httpd_recv_func_t)(httpd_handle_t hd, int sockfd, char *buf, size_t buf_len, int
flags)
Prototype for HTTPDs low-level recv function.
Espressif Systems 590
Submit Document Feedback
Release v4.4