esphome::web_server_base::WebServerBase Class Reference

#include <web_server_base.h>

Public Member Functions
void	init ()
void	deinit ()
AsyncWebServer *	get_server () const
void	set_auth_username (std::string auth_username)
void	set_auth_password (std::string auth_password)
void	add_handler (AsyncWebHandler *handler)
void	add_handler_without_auth (AsyncWebHandler *handler)
	WARNING: Registers a handler that bypasses the USE_WEBSERVER_AUTH middleware.
void	set_port (uint16_t port)
uint16_t	get_port () const

Protected Attributes
int	initialized_ {0}
uint16_t	port_ {80}
AsyncWebServer *	server_ {nullptr}
std::vector< AsyncWebHandler * >	handlers_
internal::Credentials	credentials_

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 8 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 USE_WEBSERVER_AUTH 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().

Definition at line 17 of file web_server_base.cpp.

deinit()

void esphome::web_server_base::WebServerBase::deinit ( )

inline

Definition at line 110 of file web_server_base.h.

get_port()

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

inline

Definition at line 135 of file web_server_base.h.

get_server()

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

inline

Definition at line 117 of file web_server_base.h.

init()

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

inline

Definition at line 93 of file web_server_base.h.

set_auth_password()

void esphome::web_server_base::WebServerBase::set_auth_password ( std::string auth_password )

inline

Definition at line 121 of file web_server_base.h.

set_auth_username()

void esphome::web_server_base::WebServerBase::set_auth_username ( std::string auth_username )

inline

Definition at line 120 of file web_server_base.h.

set_port()

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

inline

Definition at line 134 of file web_server_base.h.

Field Documentation

credentials_

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

protected

Definition at line 143 of file web_server_base.h.

handlers_

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

protected

Definition at line 141 of file web_server_base.h.

initialized_

int esphome::web_server_base::WebServerBase::initialized_ {0}

protected

Definition at line 138 of file web_server_base.h.

port_

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

protected

Definition at line 139 of file web_server_base.h.

server_

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

protected

Definition at line 140 of file web_server_base.h.

---

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

• esphome/components/web_server_base/web_server_base.h
• esphome/components/web_server_base/web_server_base.cpp