#include <web_server_base.h>
Definition at line 91 of file web_server_base.h.
◆ add_handler()
| void esphome::web_server_base::WebServerBase::add_handler |
( |
AsyncWebHandler * | handler | ) |
|
◆ add_handler_without_auth()
| void esphome::web_server_base::WebServerBase::add_handler_without_auth |
( |
AsyncWebHandler * | handler | ) |
|
WARNING: Registers a handler that bypasses the auth and origin middleware.
This should only be used for endpoints that are intentionally unauthenticated (for example, captive portal or very limited-status endpoints). For normal endpoints that should respect web server authentication, use add_handler(). The origin check is skipped too, so a captive portal-only build carries none of it; the portal's own pages are same-origin and the OS probes send no Origin.
Definition at line 134 of file web_server_base.cpp.
◆ deinit()
| void esphome::web_server_base::WebServerBase::deinit |
( |
| ) |
|
|
inline |
◆ get_port()
| uint16_t esphome::web_server_base::WebServerBase::get_port |
( |
| ) |
const |
|
inline |
◆ get_server()
| AsyncWebServer * esphome::web_server_base::WebServerBase::get_server |
( |
| ) |
const |
|
inline |
◆ init()
| void esphome::web_server_base::WebServerBase::init |
( |
| ) |
|
|
inline |
◆ set_allowed_origins()
| void esphome::web_server_base::WebServerBase::set_allowed_origins |
( |
const char *const * | origins | ) |
|
|
inline |
Set the extra origins browsers may make cross-origin requests from, for every handler added through add_handler().
Requests without an Origin header and same-origin requests are always allowed. Each entry must exactly match the browser's Origin header ("scheme://host[:port]"); "*" is not an entry here, codegen turns it into USE_WEBSERVER_ALLOW_ANY_ORIGIN instead.
- Parameters
-
| origins | nullptr-terminated table of allowed origins; must outlive the server. |
Definition at line 143 of file web_server_base.h.
◆ set_auth_basic_hash()
| void esphome::web_server_base::WebServerBase::set_auth_basic_hash |
( |
const char * | hash | ) |
|
|
inline |
◆ set_auth_password()
| void esphome::web_server_base::WebServerBase::set_auth_password |
( |
const char * | auth_password | ) |
|
|
inline |
◆ set_auth_username()
| void esphome::web_server_base::WebServerBase::set_auth_username |
( |
const char * | auth_username | ) |
|
|
inline |
◆ set_port()
| void esphome::web_server_base::WebServerBase::set_port |
( |
uint16_t | port | ) |
|
|
inline |
◆ allowed_origins_
| const char* const* esphome::web_server_base::WebServerBase::allowed_origins_ {nullptr} |
|
protected |
◆ credentials_
◆ handlers_
| std::vector<AsyncWebHandler *> esphome::web_server_base::WebServerBase::handlers_ |
|
protected |
◆ initialized_
| uint8_t esphome::web_server_base::WebServerBase::initialized_ {0} |
|
protected |
◆ port_
| uint16_t esphome::web_server_base::WebServerBase::port_ {80} |
|
protected |
◆ server_
| AsyncWebServer* esphome::web_server_base::WebServerBase::server_ {nullptr} |
|
protected |
The documentation for this class was generated from the following files: