mirror of
https://github.com/espressif/esp-idf.git
synced 2025-09-23 01:05:14 +00:00
esp_http_server : APIs renamed and context get/set implementations fixed
* http_sess_set_*_override APIs are now the only ones available to set custom recv/send/pending functions * Fixed side effects to using http_sess_set/get_context inside URI handlers
This commit is contained in:
Anurag Kar
@@ -516,101 +516,65 @@ typedef int (*httpd_pending_func_t)(httpd_handle_t hd, int sockfd);
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Override web server's receive function
|
||||
*
|
||||
* This function overrides the web server's receive function. This same function is
|
||||
* used to read and parse HTTP headers as well as body.
|
||||
*
|
||||
* @note This API is supposed to be called only from the context of
|
||||
* a URI handler where httpd_req_t* request pointer is valid.
|
||||
*
|
||||
* @param[in] r The request being responded to
|
||||
* @param[in] recv_func The receive function to be set for this request
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK : On successfully registering override
|
||||
* - ESP_ERR_INVALID_ARG : Null arguments
|
||||
* - ESP_ERR_HTTPD_INVALID_REQ : Invalid request pointer
|
||||
*/
|
||||
esp_err_t httpd_set_recv_override(httpd_req_t *r, httpd_recv_func_t recv_func);
|
||||
|
||||
/**
|
||||
* @brief Override web server's send function
|
||||
*
|
||||
* 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 only from the context of
|
||||
* a URI handler where httpd_req_t* request pointer is valid.
|
||||
*
|
||||
* @param[in] r The request being responded to
|
||||
* @param[in] send_func The send function to be set for this request
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK : On successfully registering override
|
||||
* - ESP_ERR_INVALID_ARG : Null arguments
|
||||
* - ESP_ERR_HTTPD_INVALID_REQ : Invalid request pointer
|
||||
*/
|
||||
esp_err_t httpd_set_send_override(httpd_req_t *r, httpd_send_func_t send_func);
|
||||
|
||||
/**
|
||||
* @brief Override web server's pending function
|
||||
*
|
||||
* 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 only from the context of
|
||||
* a URI handler where httpd_req_t* request pointer is valid.
|
||||
*
|
||||
* @param[in] r The request being responded to
|
||||
* @param[in] pending_func The pending function to be set for this request
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK : On successfully registering override
|
||||
* - ESP_ERR_INVALID_ARG : Null arguments
|
||||
* - ESP_ERR_HTTPD_INVALID_REQ : Invalid request pointer
|
||||
*/
|
||||
esp_err_t httpd_set_pending_override(httpd_req_t *r, httpd_pending_func_t pending_func);
|
||||
|
||||
/**
|
||||
* @brief Override web server's send function (by session FD)
|
||||
*
|
||||
* @see httpd_set_send_override()
|
||||
*
|
||||
* @param[in] hd HTTPD instance handle
|
||||
* @param[in] sockfd Session socket FD
|
||||
* @param[in] send_func The send function to be set for this session
|
||||
*
|
||||
* @return status code
|
||||
*/
|
||||
esp_err_t httpd_set_sess_send_override(httpd_handle_t hd, int sockfd, httpd_send_func_t send_func);
|
||||
|
||||
/**
|
||||
* @brief Override web server's receive function (by session FD)
|
||||
*
|
||||
* @see httpd_set_recv_override()
|
||||
* 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()
|
||||
*
|
||||
* @param[in] hd HTTPD instance handle
|
||||
* @param[in] sockfd Session socket FD
|
||||
* @param[in] recv_func The receive function to be set for this session
|
||||
*
|
||||
* @return status code
|
||||
* @return
|
||||
* - ESP_OK : On successfully registering override
|
||||
* - ESP_ERR_INVALID_ARG : Null arguments
|
||||
*/
|
||||
esp_err_t httpd_set_sess_recv_override(httpd_handle_t hd, int sockfd, httpd_recv_func_t recv_func);
|
||||
esp_err_t httpd_sess_set_recv_override(httpd_handle_t hd, int sockfd, httpd_recv_func_t recv_func);
|
||||
|
||||
/**
|
||||
* @brief 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()
|
||||
*
|
||||
* @param[in] hd HTTPD instance handle
|
||||
* @param[in] sockfd Session socket FD
|
||||
* @param[in] send_func The send function to be set for this session
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK : On successfully registering override
|
||||
* - ESP_ERR_INVALID_ARG : Null arguments
|
||||
*/
|
||||
esp_err_t httpd_sess_set_send_override(httpd_handle_t hd, int sockfd, httpd_send_func_t send_func);
|
||||
|
||||
/**
|
||||
* @brief Override web server's pending function (by session FD)
|
||||
*
|
||||
* @see httpd_set_pending_override()
|
||||
* 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()
|
||||
*
|
||||
* @param[in] hd HTTPD instance handle
|
||||
* @param[in] sockfd Session socket FD
|
||||
* @param[in] pending_func The receive function to be set for this session
|
||||
*
|
||||
* @return status code
|
||||
* @return
|
||||
* - ESP_OK : On successfully registering override
|
||||
* - ESP_ERR_INVALID_ARG : Null arguments
|
||||
*/
|
||||
esp_err_t httpd_set_sess_pending_override(httpd_handle_t hd, int sockfd, httpd_pending_func_t pending_func);
|
||||
esp_err_t httpd_sess_set_pending_override(httpd_handle_t hd, int sockfd, httpd_pending_func_t pending_func);
|
||||
|
||||
/**
|
||||
* @brief Get the Socket Descriptor from the HTTP request
|
||||
@@ -620,7 +584,7 @@ esp_err_t httpd_set_sess_pending_override(httpd_handle_t hd, int sockfd, httpd_p
|
||||
* This is useful when user wants to call functions that require
|
||||
* session socket fd, from within a URI handler, ie. :
|
||||
* httpd_sess_get_ctx(),
|
||||
* httpd_trigger_sess_close(),
|
||||
* httpd_sess_trigger_close(),
|
||||
* httpd_sess_update_timestamp().
|
||||
*
|
||||
* @note This API is supposed to be called only from the context of
|
||||
@@ -1144,7 +1108,7 @@ void *httpd_get_global_transport_ctx(httpd_handle_t handle);
|
||||
* - ESP_ERR_NOT_FOUND : Socket fd not found
|
||||
* - ESP_ERR_INVALID_ARG : Null arguments
|
||||
*/
|
||||
esp_err_t httpd_trigger_sess_close(httpd_handle_t handle, int sockfd);
|
||||
esp_err_t httpd_sess_trigger_close(httpd_handle_t handle, int sockfd);
|
||||
|
||||
/**
|
||||
* @brief Update timestamp for a given socket
|
||||
|
||||
Reference in New Issue
Block a user