Skip to content

feat(esp_http_server): Make HTTP(S)_SERVER_EVENT events optional (IDFGH-16707) #17799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+52 −6
Open

feat(esp_http_server): Make HTTP(S)_SERVER_EVENT events optional (IDFGH-16707) #17799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions components/esp_http_server/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 4 additions & 2 deletions components/esp_http_server/include/esp_http_server.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand All @@ -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
Expand Down
9 changes: 9 additions & 0 deletions components/esp_http_server/src/esp_httpd_priv.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

#include <esp_http_server.h>
#include "osal.h"
#include "sdkconfig.h"

#ifdef __cplusplus
extern "C" {
Expand Down Expand Up @@ -581,6 +582,8 @@ esp_err_t httpd_sess_trigger_close_(httpd_handle_t handle, struct sock_db *sessi
* @}
*/

#ifdef CONFIG_HTTPD_ENABLE_EVENTS

#if CONFIG_HTTPD_SERVER_EVENT_POST_TIMEOUT == -1
#define ESP_HTTP_SERVER_EVENT_POST_TIMEOUT portMAX_DELAY
#else
Expand All @@ -593,8 +596,14 @@ esp_err_t httpd_sess_trigger_close_(httpd_handle_t handle, struct sock_db *sessi
*/
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
Expand Down
2 changes: 2 additions & 0 deletions components/esp_http_server/src/httpd_main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
{
Expand Down
10 changes: 8 additions & 2 deletions components/esp_http_server/src/httpd_txrx.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,12 +312,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;
}

Expand Down Expand Up @@ -412,12 +414,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;
}
Expand Down Expand Up @@ -628,11 +632,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;
}

Expand Down
10 changes: 10 additions & 0 deletions components/esp_https_server/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions components/esp_https_server/include/esp_https_server.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
extern "C" {
#endif

#if CONFIG_ESP_HTTPS_SERVER_EVENTS || __DOXYGEN__
ESP_EVENT_DECLARE_BASE(ESP_HTTPS_SERVER_EVENT);

typedef enum {
Expand All @@ -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
Expand Down
7 changes: 5 additions & 2 deletions components/esp_https_server/src/https_server.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2018-2024 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2018-2025 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
Expand All @@ -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
Expand All @@ -31,14 +32,16 @@ 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);
if (err != ESP_OK) {
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)
Copy link
Member

@mahavirj mahavirj Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we use similar approach (stub out the implementation) in HTTP server component as well?

Copy link
Contributor Author

@jimmyw jimmyw Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, i had to put the stub in the internal header, but i dont see any issue with that.

#endif // CONFIG_ESP_HTTPS_SERVER_EVENTS

/**
* SSL socket close handler
Expand Down
4 changes: 4 additions & 0 deletions examples/protocols/https_server/simple/main/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,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)
Expand All @@ -42,6 +43,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)
Expand Down Expand Up @@ -257,7 +259,9 @@ void app_main(void)
ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &connect_handler, &server));
ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ETHERNET_EVENT_DISCONNECTED, &disconnect_handler, &server));
#endif // CONFIG_EXAMPLE_CONNECT_ETHERNET
#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
Expand Down