ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::web_server_base::WebServerBase Class Referencefinal

#include <web_server_base.h>

Public Member Functions

void init ()
 
void deinit ()
 
AsyncWebServer * get_server () const
 
void set_auth_username (const char *auth_username)
 
void set_auth_password (const char *auth_password)
 
void set_auth_basic_hash (const char *hash)
 
void set_allowed_origins (const char *const *origins)
 Set the extra origins browsers may make cross-origin requests from, for every handler added through add_handler().
 
void add_handler (AsyncWebHandler *handler)
 
void add_handler_without_auth (AsyncWebHandler *handler)
 WARNING: Registers a handler that bypasses the auth and origin middleware.
 
void set_port (uint16_t port)
 
uint16_t get_port () const
 

Protected Attributes

uint8_t initialized_ {0}
 
uint16_t port_ {80}
 
AsyncWebServer * server_ {nullptr}
 
std::vector< AsyncWebHandler * > handlers_
 
internal::Credentials credentials_
 
const char *const * allowed_origins_ {nullptr}
 

Detailed Description

Definition at line 91 of file web_server_base.h.

Member Function Documentation

◆ add_handler()

void esphome::web_server_base::WebServerBase::add_handler ( AsyncWebHandler * handler)

Definition at line 130 of file web_server_base.cpp.

◆ 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

Definition at line 117 of file web_server_base.h.

◆ get_port()

uint16_t esphome::web_server_base::WebServerBase::get_port ( ) const
inline

Definition at line 159 of file web_server_base.h.

◆ get_server()

AsyncWebServer * esphome::web_server_base::WebServerBase::get_server ( ) const
inline

Definition at line 125 of file web_server_base.h.

◆ init()

void esphome::web_server_base::WebServerBase::init ( )
inline

Definition at line 98 of file web_server_base.h.

◆ 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
originsnullptr-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

Definition at line 132 of file web_server_base.h.

◆ set_auth_password()

void esphome::web_server_base::WebServerBase::set_auth_password ( const char * auth_password)
inline

Definition at line 130 of file web_server_base.h.

◆ set_auth_username()

void esphome::web_server_base::WebServerBase::set_auth_username ( const char * auth_username)
inline

Definition at line 129 of file web_server_base.h.

◆ set_port()

void esphome::web_server_base::WebServerBase::set_port ( uint16_t port)
inline

Definition at line 158 of file web_server_base.h.

Field Documentation

◆ allowed_origins_

const char* const* esphome::web_server_base::WebServerBase::allowed_origins_ {nullptr}
protected

Definition at line 170 of file web_server_base.h.

◆ credentials_

internal::Credentials esphome::web_server_base::WebServerBase::credentials_
protected

Definition at line 167 of file web_server_base.h.

◆ handlers_

std::vector<AsyncWebHandler *> esphome::web_server_base::WebServerBase::handlers_
protected

Definition at line 165 of file web_server_base.h.

◆ initialized_

uint8_t esphome::web_server_base::WebServerBase::initialized_ {0}
protected

Definition at line 162 of file web_server_base.h.

◆ port_

uint16_t esphome::web_server_base::WebServerBase::port_ {80}
protected

Definition at line 163 of file web_server_base.h.

◆ server_

AsyncWebServer* esphome::web_server_base::WebServerBase::server_ {nullptr}
protected

Definition at line 164 of file web_server_base.h.


The documentation for this class was generated from the following files: