esphome::web_server_base::CaptiveDNS Class Reference

#include <captive_dns.h>

Public Member Functions
bool	start (const network::IPAddress &ip)
	Returns false when the DNS server could not start; nothing is kept, so is_running() stays false.
void	stop ()
void	loop ()
	Answer one pending query; call from the owner's loop() while running.
bool	is_running () const

Protected Attributes
std::unique_ptr< DNSServer >	dns_server_

Detailed Description

Definition at line 21 of file captive_dns.h.

Member Function Documentation

is_running()

bool esphome::web_server_base::CaptiveDNS::is_running ( ) const

inline

Definition at line 55 of file captive_dns.h.

loop()

void esphome::web_server_base::CaptiveDNS::loop ( )

inline

Answer one pending query; call from the owner's loop() while running.

Definition at line 46 of file captive_dns.h.

start()

bool esphome::web_server_base::CaptiveDNS::start ( const network::IPAddress & ip )

inline

Returns false when the DNS server could not start; nothing is kept, so is_running() stays false.

Definition at line 24 of file captive_dns.h.

stop()

void esphome::web_server_base::CaptiveDNS::stop ( )

inline

Definition at line 39 of file captive_dns.h.

Field Documentation

dns_server_

std::unique_ptr<DNSServer> esphome::web_server_base::CaptiveDNS::dns_server_

protected

Definition at line 59 of file captive_dns.h.

---

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

• esphome/components/web_server_base/captive_dns.h