Chapter 2. API Reference
Parameters
• [in] handle: handle to HTTPD server instance
• [in] uri: URI string
• [in] method: HTTP method
esp_err_t httpd_unregister_uri(httpd_handle_t
Unregister all URI handlers with the specified uri string.
Return
• ESP_OK : On successfully deregistering all such handlers
• ESP_ERR_INVALID_ARG : Null arguments
• ESP_ERR_NOT_FOUND : No handler registered with specified uri string
Parameters
• [in] handle: handle to HTTPD server instance
• [in] uri: uri string specifying all handlers that need to be deregisterd
esp_err_t httpd_sess_set_recv_override(httpd_handle_t
Override web server's receive function (by session FD)
This function overrides the web server's receive function. This same function is used to read HTTP request
packets.
Note This API is supposed to be called either from the context of
• an http session APIs where sockfd is a valid parameter
• a URI handler where sockfd is obtained using httpd_req_to_sockfd()
Return
• ESP_OK : On successfully registering override
• ESP_ERR_INVALID_ARG : Null arguments
Parameters
• [in] hd: HTTPD instance handle
• [in] sockfd: Session socket FD
• [in] recv_func: The receive function to be set for this session
esp_err_t httpd_sess_set_send_override(httpd_handle_t
Override web server's send function (by session FD)
This function overrides the web server's send function. This same function is used to send out any response
to any HTTP request.
Note This API is supposed to be called either from the context of
• an http session APIs where sockfd is a valid parameter
• a URI handler where sockfd is obtained using httpd_req_to_sockfd()
Return
• ESP_OK : On successfully registering override
• ESP_ERR_INVALID_ARG : Null arguments
Parameters
• [in] hd: HTTPD instance handle
• [in] sockfd: Session socket FD
• [in] send_func: The send function to be set for this session
esp_err_t httpd_sess_set_pending_override(httpd_handle_t
Override web server's pending function (by session FD)
This function overrides the web server's pending function. This function is used to test for pending bytes in
a socket.
Note This API is supposed to be called either from the context of
• an http session APIs where sockfd is a valid parameter
• a URI handler where sockfd is obtained using httpd_req_to_sockfd()
Return
• ESP_OK : On successfully registering override
Espressif Systems
handle, const char *uri)
recv_func)
send_func)
httpd_pending_func_t
575
Submit Document Feedback
hd, int sockfd,
httpd_recv_func_t
hd, int sockfd,
httpd_send_func_t
hd,
int
pending_func)
sockfd,
Release v4.4
Need help?
Do you have a question about the ESP32-S2 and is the answer not in the manual?