#include <web_server_base.h>
Inheritance diagram for esphome::web_server_base::WebServerBase:
Public Member Functions | |
| void | init () |
| void | deinit () |
| std::shared_ptr< AsyncWebServer > | get_server () const |
| float | get_setup_priority () const override |
| void | set_auth_username (std::string auth_username) |
| void | set_auth_password (std::string auth_password) |
| void | add_handler (AsyncWebHandler *handler) |
| void | add_ota_handler () |
| void | set_port (uint16_t port) |
| uint16_t | get_port () const |
 Public Member Functions inherited from esphome::Component | |
| virtual void | setup () |
| Where the component's initialization should happen. More... | |
| virtual void | loop () |
| This method will be called repeatedly. More... | |
| virtual void | dump_config () |
| float | get_actual_setup_priority () const |
| void | set_setup_priority (float priority) |
| virtual float | get_loop_priority () const |
| priority of loop(). More... | |
| void | call () |
| virtual void | on_shutdown () |
| virtual void | on_safe_shutdown () |
| uint32_t | get_component_state () const |
| virtual void | mark_failed () |
| Mark this component as failed. More... | |
| bool | is_failed () const |
| bool | is_ready () const |
| virtual bool | can_proceed () |
| bool | status_has_warning () const |
| bool | status_has_error () const |
| void | status_set_warning (const char *message="unspecified") |
| void | status_set_error (const char *message="unspecified") |
| void | status_clear_warning () |
| void | status_clear_error () |
| void | status_momentary_warning (const std::string &name, uint32_t length=5000) |
| void | status_momentary_error (const std::string &name, uint32_t length=5000) |
| bool | has_overridden_loop () const |
| void | set_component_source (const char *source) |
| Set where this component was loaded from for some debug messages. More... | |
| const char * | get_component_source () const |
| Get the integration where this component was declared as a string. More... | |
Protected Attributes | |
| int | initialized_ {0} |
| uint16_t | port_ {80} |
| std::shared_ptr< AsyncWebServer > | server_ {nullptr} |
| std::vector< AsyncWebHandler * > | handlers_ |
| internal::Credentials | credentials_ |
| Protected Attributes inherited from esphome::Component | |
| uint32_t | component_state_ {0x0000} |
| State of this component. More... | |
| float | setup_priority_override_ {NAN} |
| const char * | component_source_ {nullptr} |
Additional Inherited Members | |
| Protected Member Functions inherited from esphome::Component | |
| virtual void | call_loop () |
| virtual void | call_setup () |
| virtual void | call_dump_config () |
| void | set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f) |
| Set an interval function with a unique name. More... | |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| bool | cancel_interval (const std::string &name) |
| Cancel an interval function. More... | |
| void | set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f) |
| Set an retry function with a unique name. More... | |
| void | set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f) |
| bool | cancel_retry (const std::string &name) |
| Cancel a retry function. More... | |
| void | set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f) |
| Set a timeout function with a unique name. More... | |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| bool | cancel_timeout (const std::string &name) |
| Cancel a timeout function. More... | |
| void | defer (const std::string &name, std::function< void()> &&f) |
| Defer a callback to the next loop() call. More... | |
| void | defer (std::function< void()> &&f) |
| Defer a callback to the next loop() call. More... | |
| bool | cancel_defer (const std::string &name) |
| Cancel a defer callback using the specified name, name must not be empty. More... | |
Detailed Description
Definition at line 82 of file web_server_base.h.
Member Function Documentation
◆ add_handler()
| void esphome::web_server_base::WebServerBase::add_handler | ( | AsyncWebHandler * | handler | ) |
Definition at line 22 of file web_server_base.cpp.
◆ add_ota_handler()
| void esphome::web_server_base::WebServerBase::add_ota_handler | ( | ) |
Definition at line 113 of file web_server_base.cpp.
◆ deinit()
|
inline |
Definition at line 99 of file web_server_base.h.
◆ get_port()
|
inline |
Definition at line 116 of file web_server_base.h.
◆ get_server()
|
inline |
Definition at line 105 of file web_server_base.h.
◆ get_setup_priority()
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 118 of file web_server_base.cpp.
◆ init()
|
inline |
Definition at line 84 of file web_server_base.h.
◆ set_auth_password()
|
inline |
Definition at line 109 of file web_server_base.h.
◆ set_auth_username()
|
inline |
Definition at line 108 of file web_server_base.h.
◆ set_port()
|
inline |
Definition at line 115 of file web_server_base.h.
Field Documentation
◆ credentials_
|
protected |
Definition at line 125 of file web_server_base.h.
◆ handlers_
|
protected |
Definition at line 124 of file web_server_base.h.
◆ initialized_
|
protected |
Definition at line 121 of file web_server_base.h.
◆ port_
|
protected |
Definition at line 122 of file web_server_base.h.
◆ server_
|
protected |
Definition at line 123 of file web_server_base.h.
The documentation for this class was generated from the following files:
- /opt/build/esphome/esphome/components/web_server_base/web_server_base.h
- /opt/build/esphome/esphome/components/web_server_base/web_server_base.cpp
