My Project
 All Classes Functions Variables Pages
WiFiEventHandler.h
1 /*
2  * WiFiEventHandler.h
3  *
4  * Created on: Feb 25, 2017
5  * Author: kolban
6  *
7  * A WiFiEventHandler defines a class that has methods that will be called back when a WiFi event is
8  * detected.
9  *
10  * Typically this class is subclassed to provide implementations for the callbacks we want to handle.
11  *
12  * class MyHandler: public WiFiEventHandler {
13  * esp_err_t apStart() {
14  * ESP_LOGD(tag, "MyHandler(Class): apStart");
15  * return ESP_OK;
16  * }
17  * }
18  *
19  * WiFi wifi;
20  * MyHandler *eventHandler = new MyHandler();
21  * wifi.setWifiEventHandler(eventHandler);
22  * wifi.startAP("MYSSID", "password");
23  *
24  * The overridable functions are:
25  * * esp_err_t apStaConnected(system_event_ap_staconnected_t info)
26  * * esp_err_t apStaDisconnected(system_event_ap_stadisconnected_t info)
27  * * esp_err_t apStart()
28  * * esp_err_t apStop()
29  * * esp_err_t staConnected(system_event_sta_connected_t info)
30  * * esp_err_t staDisconnected(system_event_sta_disconnected_t info)
31  * * esp_err_t staGotIp(system_event_sta_got_ip_t info)
32  * * esp_err_t staScanDone(system_event_sta_scan_done_t info)
33  * * esp_err_t staAuthChange(system_event_sta_authmode_change_t info)
34  * * esp_err_t staStart()
35  * * esp_err_t staStop()
36  * * esp_err_t wifiReady()
37  */
38 
39 #ifndef MAIN_WIFIEVENTHANDLER_H_
40 #define MAIN_WIFIEVENTHANDLER_H_
41 #include <esp_event.h>
42 #include <esp_event_loop.h>
43 
99 public:
101  virtual ~WiFiEventHandler();
102  virtual esp_err_t apStaConnected(system_event_ap_staconnected_t info);
103  virtual esp_err_t apStaDisconnected(system_event_ap_stadisconnected_t info);
104  virtual esp_err_t apStart();
105  virtual esp_err_t apStop();
106  system_event_cb_t getEventHandler();
107  virtual esp_err_t staConnected(system_event_sta_connected_t info);
108  virtual esp_err_t staDisconnected(system_event_sta_disconnected_t info);
109  virtual esp_err_t staGotIp(system_event_sta_got_ip_t info);
110  virtual esp_err_t staScanDone(system_event_sta_scan_done_t info);
111  virtual esp_err_t staAuthChange(system_event_sta_authmode_change_t info);
112  virtual esp_err_t staStart();
113  virtual esp_err_t staStop();
114  virtual esp_err_t wifiReady();
115 
121  return m_nextHandler;
122  }
123 
128  void setNextHandler(WiFiEventHandler* nextHandler) {
129  this->m_nextHandler = nextHandler;
130  }
131 
132 private:
133  friend class WiFi;
134  WiFiEventHandler *m_nextHandler;
135  static esp_err_t eventHandler(void* ctx, system_event_t* event);
136 
137 };
138 
139 #endif /* MAIN_WIFIEVENTHANDLER_H_ */
virtual esp_err_t staScanDone(system_event_sta_scan_done_t info)
Handle a Scan for APs done event. Handle having an ESP32 station scan (APs) done. ...
Definition: WiFiEventHandler.cpp:236
WiFiEventHandler()
Constructor.
Definition: WiFiEventHandler.cpp:113
virtual esp_err_t staGotIp(system_event_sta_got_ip_t info)
Handle the Station Got IP event. Handle having received/assigned an IP address when we are a station...
Definition: WiFiEventHandler.cpp:136
virtual esp_err_t apStaDisconnected(system_event_ap_stadisconnected_t info)
Handle a Station Disconnected from AP event. Handle having a station disconnected from ESP32 soft-AP...
Definition: WiFiEventHandler.cpp:224
void setNextHandler(WiFiEventHandler *nextHandler)
Definition: WiFiEventHandler.h:128
WiFiEventHandler * getNextHandler()
Definition: WiFiEventHandler.h:120
WiFi driver.
Definition: WiFi.h:111
system_event_cb_t getEventHandler()
Get the event handler. Retrieve the event handler function to be passed to the ESP-IDF event handler ...
Definition: WiFiEventHandler.cpp:123
virtual esp_err_t staAuthChange(system_event_sta_authmode_change_t info)
Handle the auth mode of APs change event. Handle having the auth mode of AP ESP32 station connected t...
Definition: WiFiEventHandler.cpp:248
virtual esp_err_t staConnected(system_event_sta_connected_t info)
Handle the Station Connected event. Handle having connected to remote AP.
Definition: WiFiEventHandler.cpp:188
virtual esp_err_t apStop()
Handle the Access Point stop event. Handle an indication that the ESP32 has stopped being an access p...
Definition: WiFiEventHandler.cpp:158
virtual esp_err_t staDisconnected(system_event_sta_disconnected_t info)
Handle the Station Disconnected event. Handle having disconnected from remote AP. ...
Definition: WiFiEventHandler.cpp:200
virtual esp_err_t apStart()
Handle the Access Point started event. Handle an indication that the ESP32 has started being an acces...
Definition: WiFiEventHandler.cpp:147
WiFi state event handler.
Definition: WiFiEventHandler.h:98
virtual esp_err_t apStaConnected(system_event_ap_staconnected_t info)
Handle a Station Connected to AP event. Handle having a station connected to ESP32 soft-AP...
Definition: WiFiEventHandler.cpp:212