roo_wifi
API Documentation for roo_wifi
Loading...
Searching...
No Matches
roo_wifi::ArduinoPreferencesStore Class Reference

Store implementation backed by roo_prefs (ESP32 Arduino preferences). More...

#include <arduino_preferences_store.h>

Inheritance diagram for roo_wifi::ArduinoPreferencesStore:
[legend]
Collaboration diagram for roo_wifi::ArduinoPreferencesStore:
[legend]

Public Member Functions

 ArduinoPreferencesStore ()
 
void begin ()
 Initializes the preferences store (no-op placeholder).
 
bool getIsInterfaceEnabled () override
 Returns whether the Wi-Fi interface is enabled.
 
void setIsInterfaceEnabled (bool enabled) override
 Sets whether the Wi-Fi interface is enabled.
 
std::string getDefaultSSID () override
 Returns the default SSID, if any.
 
void clearDefaultSSID () override
 Clears the default SSID.
 
void setDefaultSSID (const std::string &ssid) override
 Sets the default SSID.
 
bool getPassword (const std::string &ssid, std::string &password) override
 Retrieves a stored password for an SSID.
 
void setPassword (const std::string &ssid, roo::string_view password) override
 Stores a password for an SSID.
 
void clearPassword (const std::string &ssid) override
 Clears a stored password for an SSID.
 

Detailed Description

Store implementation backed by roo_prefs (ESP32 Arduino preferences).

Definition at line 9 of file arduino_preferences_store.h.

Constructor & Destructor Documentation

◆ ArduinoPreferencesStore()

roo_wifi::ArduinoPreferencesStore::ArduinoPreferencesStore ( )

Definition at line 32 of file arduino_preferences_store.cpp.

Member Function Documentation

◆ begin()

void roo_wifi::ArduinoPreferencesStore::begin ( )
inline

Initializes the preferences store (no-op placeholder).

Definition at line 14 of file arduino_preferences_store.h.

◆ clearDefaultSSID()

void roo_wifi::ArduinoPreferencesStore::clearDefaultSSID ( )
overridevirtual

Clears the default SSID.

Implements roo_wifi::Store.

Definition at line 53 of file arduino_preferences_store.cpp.

◆ clearPassword()

void roo_wifi::ArduinoPreferencesStore::clearPassword ( const std::string &  ssid)
overridevirtual

Clears a stored password for an SSID.

Implements roo_wifi::Store.

Definition at line 74 of file arduino_preferences_store.cpp.

◆ getDefaultSSID()

std::string roo_wifi::ArduinoPreferencesStore::getDefaultSSID ( )
overridevirtual

Returns the default SSID, if any.

Implements roo_wifi::Store.

Definition at line 45 of file arduino_preferences_store.cpp.

◆ getIsInterfaceEnabled()

bool roo_wifi::ArduinoPreferencesStore::getIsInterfaceEnabled ( )
overridevirtual

Returns whether the Wi-Fi interface is enabled.

Implements roo_wifi::Store.

Definition at line 37 of file arduino_preferences_store.cpp.

◆ getPassword()

bool roo_wifi::ArduinoPreferencesStore::getPassword ( const std::string &  ssid,
std::string &  password 
)
overridevirtual

Retrieves a stored password for an SSID.

Implements roo_wifi::Store.

Definition at line 58 of file arduino_preferences_store.cpp.

◆ setDefaultSSID()

void roo_wifi::ArduinoPreferencesStore::setDefaultSSID ( const std::string &  ssid)
overridevirtual

Sets the default SSID.

Implements roo_wifi::Store.

Definition at line 49 of file arduino_preferences_store.cpp.

◆ setIsInterfaceEnabled()

void roo_wifi::ArduinoPreferencesStore::setIsInterfaceEnabled ( bool  enabled)
overridevirtual

Sets whether the Wi-Fi interface is enabled.

Implements roo_wifi::Store.

Definition at line 41 of file arduino_preferences_store.cpp.

◆ setPassword()

void roo_wifi::ArduinoPreferencesStore::setPassword ( const std::string &  ssid,
roo::string_view  password 
)
overridevirtual

Stores a password for an SSID.

Implements roo_wifi::Store.

Definition at line 66 of file arduino_preferences_store.cpp.


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