SensESP 3.0.1
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::WiFiStateProducer Class Reference

Provide information about the current WiFi state. More...

#include <sensesp/net/networking.h>

Inheritance diagram for sensesp::WiFiStateProducer:
[legend]

Public Member Functions

 WiFiStateProducer ()
 
 ~WiFiStateProducer ()
 
 WiFiStateProducer (WiFiStateProducer &other)=delete
 
void operator= (const WiFiStateProducer &)=delete
 
- Public Member Functions inherited from sensesp::ValueProducer< WiFiState >
 ValueProducer ()
 
 ValueProducer (const WiFiState &initial_value)
 
virtual const WiFiStateget () const
 
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< WiFiState, typenameVConsumer::input_type >::value, std::shared_ptr< VConsumer > >::type connect_to (std::shared_ptr< VConsumer > consumer)
 Connect a producer to a transform with a different input type.
 
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< WiFiState, typenameVConsumer::input_type >::value, VConsumer * >::type connect_to (VConsumer *consumer)
 
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< WiFiState, typenameVConsumer::input_type >::value, VConsumer * >::type connect_to (VConsumer &consumer)
 
void emit (const WiFiState &new_value)
 
- Public Member Functions inherited from sensesp::Observable
 Observable ()
 
 Observable (Observable &&other)
 Move constructor.
 
void notify ()
 
void attach (std::function< void()> observer)
 

Protected Member Functions

void setup_wifi_callbacks ()
 
void remove_wifi_callbacks ()
 
void wifi_station_connected ()
 
void wifi_ap_enabled ()
 
void wifi_disconnected ()
 

Protected Attributes

wifi_event_id_t wifi_sta_got_ip_event_id_
 
wifi_event_id_t wifi_ap_start_event_id_
 
wifi_event_id_t wifi_sta_disconnected_event_id_
 
wifi_event_id_t wifi_ap_stop_event_id_
 
- Protected Attributes inherited from sensesp::ValueProducer< WiFiState >
WiFiState output_
 

Detailed Description

Provide information about the current WiFi state.

WiFiStateProducer reads the current network state using Arduino Core callbacks. It is a replacement for the Networking class ValueProducer output and effectively decouples the Networkig class from the rest of the system. This allows for replacing the Networking class with a different implementation.

Definition at line 29 of file networking.h.

Constructor & Destructor Documentation

◆ WiFiStateProducer() [1/2]

sensesp::WiFiStateProducer::WiFiStateProducer ( )
inline

Definition at line 31 of file networking.h.

Here is the call graph for this function:

◆ ~WiFiStateProducer()

sensesp::WiFiStateProducer::~WiFiStateProducer ( )
inline

Definition at line 40 of file networking.h.

Here is the call graph for this function:

◆ WiFiStateProducer() [2/2]

sensesp::WiFiStateProducer::WiFiStateProducer ( WiFiStateProducer & other)
delete

Member Function Documentation

◆ operator=()

void sensesp::WiFiStateProducer::operator= ( const WiFiStateProducer & )
delete

◆ remove_wifi_callbacks()

void sensesp::WiFiStateProducer::remove_wifi_callbacks ( )
inlineprotected

Definition at line 73 of file networking.h.

Here is the caller graph for this function:

◆ setup_wifi_callbacks()

void sensesp::WiFiStateProducer::setup_wifi_callbacks ( )
inlineprotected

Definition at line 51 of file networking.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ wifi_ap_enabled()

void sensesp::WiFiStateProducer::wifi_ap_enabled ( )
inlineprotected

Definition at line 91 of file networking.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ wifi_disconnected()

void sensesp::WiFiStateProducer::wifi_disconnected ( )
inlineprotected

Definition at line 104 of file networking.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ wifi_station_connected()

void sensesp::WiFiStateProducer::wifi_station_connected ( )
inlineprotected

Definition at line 80 of file networking.h.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ wifi_ap_start_event_id_

wifi_event_id_t sensesp::WiFiStateProducer::wifi_ap_start_event_id_
protected

Definition at line 47 of file networking.h.

◆ wifi_ap_stop_event_id_

wifi_event_id_t sensesp::WiFiStateProducer::wifi_ap_stop_event_id_
protected

Definition at line 49 of file networking.h.

◆ wifi_sta_disconnected_event_id_

wifi_event_id_t sensesp::WiFiStateProducer::wifi_sta_disconnected_event_id_
protected

Definition at line 48 of file networking.h.

◆ wifi_sta_got_ip_event_id_

wifi_event_id_t sensesp::WiFiStateProducer::wifi_sta_got_ip_event_id_
protected

Definition at line 46 of file networking.h.


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