Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-10-01 18:50:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat(esp_http_server): Make HTTP(S)_SERVER_EVENT events optional

Browse Source 
Make it possible to disable http(s) server events. This improves
performance of the server, as http server creates events on every signle
read or write to the socket.
This commit is contained in:
Jimmy Wennlund
2026-05-27 11:58:58 +05:30
committed by Hrushikesh Bhosale
parent 8f3d8b41c3
commit 6036ec961d
9 changed files with 53 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/esp_http_server/Kconfig
+8
View File
@@ -57,8 +57,16 @@ menu "HTTP Server"
It internally uses a counting semaphore with count set to `LWIP_UDP_RECVMBOX_SIZE` to achieve this.
This config will slightly change API behavior to block until message gets delivered on control socket.
config HTTPD_ENABLE_EVENTS
bool "Enable ESP_HTTP_SERVER_EVENT"
default y
help
This enables the ESP_HTTP_SERVER_EVENT event type. Generating these eventes adds some overhead.
If you are not using this event type, you can disable it to save some memory and add performance.
config HTTPD_SERVER_EVENT_POST_TIMEOUT
int "Time in millisecond to wait for posting event"
depends on HTTPD_ENABLE_EVENTS
default 2000
help
This config option helps in setting the time in millisecond to wait for event to be posted to the
components/esp_http_server/include/esp_http_server.h
+4 -2
View File
@@ -23,8 +23,6 @@ extern "C" {
#define ESP_HTTPD_DEF_CTRL_PORT (32768) /*!< HTTP Server control socket port*/
ESP_EVENT_DECLARE_BASE(ESP_HTTP_SERVER_EVENT);
/**
* @brief HTTP Server events id
*/
@@ -40,11 +38,15 @@ typedef enum {
HTTP_SERVER_EVENT_STOP, /*!< This event occurs when HTTP Server is stopped */
} esp_http_server_event_id_t;
#if CONFIG_HTTPD_ENABLE_EVENTS || __DOXYGEN_
ESP_EVENT_DECLARE_BASE(ESP_HTTP_SERVER_EVENT);
/** Argument structure for HTTP_SERVER_EVENT_ON_DATA and HTTP_SERVER_EVENT_SENT_DATA event */
typedef struct {
int fd; /*!< Session socket file descriptor */
int data_len; /*!< Data length */
} esp_http_server_event_data;
#endif // CONFIG_HTTPD_ENABLE_EVENTS || __DOXYGEN_
/*
note: esp_https_server.h includes a customized copy of this
components/esp_http_server/src/esp_httpd_priv.h
+11
View File
@@ -17,6 +17,7 @@
#include <esp_http_server.h>
#include "osal.h"
#include "sdkconfig.h"
#ifdef __cplusplus
extern "C" {
@@ -591,6 +592,8 @@ esp_err_t httpd_sess_close_lru_direct(struct httpd_data *hd);
* @}
*/
#ifdef CONFIG_HTTPD_ENABLE_EVENTS
#if CONFIG_HTTPD_SERVER_EVENT_POST_TIMEOUT == -1
#define ESP_HTTP_SERVER_EVENT_POST_TIMEOUT portMAX_DELAY
#else
@@ -603,6 +606,14 @@ esp_err_t httpd_sess_close_lru_direct(struct httpd_data *hd);
*/
void esp_http_server_dispatch_event(int32_t event_id, const void* event_data, size_t event_data_size);
#else // CONFIG_HTTPD_ENABLE_EVENTS
#define esp_http_server_dispatch_event(event_id, event_data, event_data_size) do {} while(0)
#endif // CONFIG_HTTPD_ENABLE_EVENTS
esp_err_t httpd_crypto_sha1(const uint8_t *data, size_t data_len, uint8_t *hash);
#ifdef __cplusplus
}
#endif
components/esp_http_server/src/httpd_main.c
+2
View File
@@ -38,6 +38,7 @@ typedef struct {
static const char *TAG = "httpd";
#ifdef CONFIG_HTTPD_ENABLE_EVENTS
ESP_EVENT_DEFINE_BASE(ESP_HTTP_SERVER_EVENT);
void esp_http_server_dispatch_event(int32_t event_id, const void* event_data, size_t event_data_size)
@@ -47,6 +48,7 @@ void esp_http_server_dispatch_event(int32_t event_id, const void* event_data, si
ESP_LOGE(TAG, "Failed to post esp_http_server event: %s", esp_err_to_name(err));
}
}
#endif // CONFIG_HTTPD_ENABLE_EVENTS
static esp_err_t httpd_accept_conn(struct httpd_data *hd, int listen_fd)
{
components/esp_http_server/src/httpd_txrx.c
+8 -2
View File
@@ -330,12 +330,14 @@ esp_err_t httpd_resp_send(httpd_req_t *r, const char *buf, ssize_t buf_len)
return ESP_ERR_HTTPD_RESP_SEND;
}
}
hd->http_server_state = HTTP_SERVER_EVENT_SENT_DATA;
#ifdef CONFIG_HTTPD_ENABLE_EVENTS
esp_http_server_event_data evt_data = {
.fd = ra->sd->fd,
.data_len = buf_len,
};
hd->http_server_state = HTTP_SERVER_EVENT_SENT_DATA;
esp_http_server_dispatch_event(HTTP_SERVER_EVENT_SENT_DATA, &evt_data, sizeof(esp_http_server_event_data));
#endif // CONFIG_HTTPD_ENABLE_EVENTS
return ESP_OK;
}
@@ -430,12 +432,14 @@ esp_err_t httpd_resp_send_chunk(httpd_req_t *r, const char *buf, ssize_t buf_len
if (httpd_send_all(r, "\r\n", strlen("\r\n")) != ESP_OK) {
return ESP_ERR_HTTPD_RESP_SEND;
}
hd->http_server_state = HTTP_SERVER_EVENT_SENT_DATA;
#ifdef CONFIG_HTTPD_ENABLE_EVENTS
esp_http_server_event_data evt_data = {
.fd = ra->sd->fd,
.data_len = buf_len,
};
hd->http_server_state = HTTP_SERVER_EVENT_SENT_DATA;
esp_http_server_dispatch_event(HTTP_SERVER_EVENT_SENT_DATA, &evt_data, sizeof(esp_http_server_event_data));
#endif // CONFIG_HTTPD_ENABLE_EVENTS
return ESP_OK;
}
@@ -646,11 +650,13 @@ int httpd_req_recv(httpd_req_t *r, char *buf, size_t buf_len)
ESP_LOGD(TAG, LOG_FMT("received length = %d"), ret);
struct httpd_data *hd = (struct httpd_data *) r->handle;
hd->http_server_state = HTTP_SERVER_EVENT_ON_DATA;
#ifdef CONFIG_HTTPD_ENABLE_EVENTS
esp_http_server_event_data evt_data = {
.fd = ra->sd->fd,
.data_len = ret,
};
esp_http_server_dispatch_event(HTTP_SERVER_EVENT_ON_DATA, &evt_data, sizeof(esp_http_server_event_data));
#endif // CONFIG_HTTPD_ENABLE_EVENTS
return ret;
}
components/esp_https_server/Kconfig
+10
View File
@@ -6,8 +6,18 @@ menu "ESP HTTPS server"
help
Enable ESP HTTPS server component
config ESP_HTTPS_SERVER_EVENTS
bool "Enable ESP_HTTPS_SERVER_EVENT event type"
depends on ESP_HTTPS_SERVER_ENABLE
default y
help
This enables the ESP_HTTPS_SERVER_EVENT event type. Generating these eventes adds some overhead.
If you are not using this event type, you can disable it to save some memory.
config ESP_HTTPS_SERVER_EVENT_POST_TIMEOUT
int "Time in millisecond to wait for posting event"
depends on (ESP_HTTPS_SERVER_ENABLE && ESP_HTTPS_SERVER_EVENTS)
default 2000
help
This config option helps in setting the time in millisecond to wait for event to be posted to the
components/esp_https_server/include/esp_https_server.h
+2
View File
@@ -18,6 +18,7 @@
extern "C" {
#endif
#if CONFIG_ESP_HTTPS_SERVER_EVENTS || __DOXYGEN__
ESP_EVENT_DECLARE_BASE(ESP_HTTPS_SERVER_EVENT);
typedef enum {
@@ -29,6 +30,7 @@ typedef enum {
HTTPS_SERVER_EVENT_DISCONNECTED, /*!< The connection has been disconnected */
HTTPS_SERVER_EVENT_STOP, /*!< This event occurs when HTTPS Server is stopped */
} esp_https_server_event_id_t;
#endif // CONFIG_ESP_HTTPS_SERVER_EVENTS || __DOXYGEN__
typedef enum {
HTTPD_SSL_TRANSPORT_SECURE, // SSL Enabled
components/esp_https_server/src/https_server.c
+4 -1
View File
@@ -23,6 +23,7 @@ typedef struct httpd_ssl_transport_ctx {
httpd_ssl_ctx_t *global_ctx;
} httpd_ssl_transport_ctx_t;
#ifdef CONFIG_ESP_HTTPS_SERVER_EVENTS
ESP_EVENT_DEFINE_BASE(ESP_HTTPS_SERVER_EVENT);
#if CONFIG_ESP_HTTPS_SERVER_EVENT_POST_TIMEOUT == -1
@@ -31,7 +32,6 @@ ESP_EVENT_DEFINE_BASE(ESP_HTTPS_SERVER_EVENT);
#define ESP_HTTPS_SERVER_EVENT_POST_TIMEOUT pdMS_TO_TICKS(CONFIG_ESP_HTTPS_SERVER_EVENT_POST_TIMEOUT)
#endif
static void http_dispatch_event_to_event_loop(int32_t event_id, const void* event_data, size_t event_data_size)
{
esp_err_t err = esp_event_post(ESP_HTTPS_SERVER_EVENT, event_id, event_data, event_data_size, ESP_HTTPS_SERVER_EVENT_POST_TIMEOUT);
@@ -39,6 +39,9 @@ static void http_dispatch_event_to_event_loop(int32_t event_id, const void* even
ESP_LOGE(TAG, "Failed to post http_client event: %"PRId32", error: %s", event_id, esp_err_to_name(err));
}
}
#else // CONFIG_ESP_HTTPS_SERVER_EVENTS
#define http_dispatch_event_to_event_loop(event_id, event_data, event_data_size) do {} while (0)
#endif // CONFIG_ESP_HTTPS_SERVER_EVENTS
/**
* SSL socket close handler
examples/protocols/https_server/simple/main/main.c
+4
View File
@@ -37,6 +37,7 @@
static const char *TAG = "example";
#ifdef CONFIG_ESP_HTTPS_SERVER_EVENTS
/* Event handler for catching system events */
static void event_handler(void* arg, esp_event_base_t event_base,
int32_t event_id, void* event_data)
@@ -48,6 +49,7 @@ static void event_handler(void* arg, esp_event_base_t event_base,
}
}
}
#endif // CONFIG_ESP_HTTPS_SERVER_EVENTS
/* An HTTP GET handler */
static esp_err_t root_get_handler(httpd_req_t *req)
@@ -295,7 +297,9 @@ void app_main(void)
ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ETHERNET_EVENT_DISCONNECTED, &disconnect_handler, &server));
#endif // CONFIG_EXAMPLE_CONNECT_ETHERNET
#endif // !CONFIG_IDF_TARGET_LINUX
#ifdef CONFIG_ESP_HTTPS_SERVER_EVENTS
ESP_ERROR_CHECK(esp_event_handler_register(ESP_HTTPS_SERVER_EVENT, ESP_EVENT_ANY_ID, &event_handler, NULL));
#endif // CONFIG_ESP_HTTPS_SERVER_EVENTS
/* This helper function configures Wi-Fi or Ethernet, as selected in menuconfig.
* Read "Establishing Wi-Fi or Ethernet Connection" section in