Class WiFiEventHandler

Inheritance Relationships

Derived Type

Class Documentation

class network::WiFiEventHandler

Methods that will be called back when a Wi-Fi event happens.

Typically this class is subclassed to provide implementations for the callbacks we want to handle:

class MyHandler : public WiFiEventHandler {
    esp_err_t apStart() {
        ESP_LOGD(tag, "MyHandler(Class): apStart");
        return ESP_OK;
    }
}

Subclassed by network::WiFiDefaultEventHandler

Public Functions

WiFiEventHandler()

Construct a new Wi-Fi event handler object.

esp_err_t staScanDone(wifi_event_sta_scan_done_t *info)

“Scan Done” handler

Return

  • ESP_OK: succeed

  • (others): failed

Parameters

  • info: event information

esp_err_t staStart()

“Station Start” handler

Return

  • ESP_OK: succeed

  • (others): failed

esp_err_t staStop()

“Station Stop” handler

Return

  • ESP_OK: succeed

  • (others): failed

esp_err_t staConnected(wifi_event_sta_connected_t *info)

“Station Connected” handler

Return

  • ESP_OK: succeed

  • (others): failed

Parameters

  • info: event information

esp_err_t staDisconnected(wifi_event_sta_disconnected_t *info)

“Station Disconnected” event

Return

  • ESP_OK: succeed

  • (others): failed

Parameters

  • info: event information

esp_err_t staAuthChange(wifi_event_sta_authmode_change_t *info)

“Authentication Mode Change” handler

Return

  • ESP_OK: succeed

  • (others): failed

Parameters

  • info: event information

esp_err_t staGotIp(ip_event_got_ip_t *info)

“Station Got IP” handler

Return

  • ESP_OK: succeed

  • (others): failed

Parameters

  • info: event information

esp_err_t apStart()

“AP Start” handler

Return

  • ESP_OK: succeed

  • (others): failed

esp_err_t apStop()

“AP Stop” handler

Return

  • ESP_OK: succeed

  • (others): failed

esp_err_t apStaConnected(wifi_event_ap_staconnected_t *info)

“AP Station Connected” handler

Return

  • ESP_OK: succeed

  • (others): failed

Parameters

  • info: event information

esp_err_t apStaDisconnected(wifi_event_ap_stadisconnected_t *info)

“Station Disconnected” from AP event

Return

  • ESP_OK: succeed

  • (others): failed

Parameters

  • info: event information

void setNextHandler(std::unique_ptr<WiFiEventHandler> &&next_handler)

Set the next WiFi event handler in the chain.

Parameters

  • next_handler: the next Wi-Fi event handler in the chain

esp_err_t eventDispatcher(std::int32_t event_id, void *event_data)

Dispatch events by calling the respective WiFiEventHander methods.

Return

  • ESP_OK: succeed

  • (others): failed

Parameters

  • [in] event_id: The Wi-Fi event ID.

  • [in] event_data: Data about the event