roo_wifi::Store Class Reference

Abstraction for persistently storing Wi-Fi controller data. More...

#include <store.h>

Inheritance diagram for roo_wifi::Store:

Public Member Functions
virtual bool	getIsInterfaceEnabled ()=0
	Returns whether the Wi-Fi interface is enabled.
virtual void	setIsInterfaceEnabled (bool enabled)=0
	Sets whether the Wi-Fi interface is enabled.
virtual std::string	getDefaultSSID ()=0
	Returns the default SSID, if any.
virtual void	setDefaultSSID (const std::string &ssid)=0
	Sets the default SSID.
virtual void	clearDefaultSSID ()=0
	Clears the default SSID.
virtual bool	getPassword (const std::string &ssid, std::string &password)=0
	Retrieves a stored password for an SSID.
virtual void	setPassword (const std::string &ssid, roo::string_view password)=0
	Stores a password for an SSID.
virtual void	clearPassword (const std::string &ssid)=0
	Clears a stored password for an SSID.

Detailed Description

Abstraction for persistently storing Wi-Fi controller data.

Definition at line 14 of file store.h.

Member Function Documentation

clearDefaultSSID()

virtual void roo_wifi::Store::clearDefaultSSID ( )

pure virtual

Clears the default SSID.

Implemented in roo_wifi::ArduinoPreferencesStore.

Referenced by roo_wifi::Controller::forget().

clearPassword()

virtual void roo_wifi::Store::clearPassword ( const std::string &  ssid )

pure virtual

Clears a stored password for an SSID.

Implemented in roo_wifi::ArduinoPreferencesStore.

Referenced by roo_wifi::Controller::forget().

getDefaultSSID()

virtual std::string roo_wifi::Store::getDefaultSSID ( )

pure virtual

Returns the default SSID, if any.

Implemented in roo_wifi::ArduinoPreferencesStore.

Referenced by roo_wifi::Controller::begin(), roo_wifi::Controller::connect(), roo_wifi::Controller::connect(), and roo_wifi::Controller::forget().

getIsInterfaceEnabled()

virtual bool roo_wifi::Store::getIsInterfaceEnabled ( )

pure virtual

Returns whether the Wi-Fi interface is enabled.

Implemented in roo_wifi::ArduinoPreferencesStore.

Referenced by roo_wifi::Controller::begin().

getPassword()

virtual bool roo_wifi::Store::getPassword ( const std::string &  ssid, std::string &  password  )

pure virtual

Retrieves a stored password for an SSID.

Implemented in roo_wifi::ArduinoPreferencesStore.

Referenced by roo_wifi::Controller::connect(), roo_wifi::Controller::connect(), and roo_wifi::Controller::getStoredPassword().

setDefaultSSID()

virtual void roo_wifi::Store::setDefaultSSID ( const std::string &  ssid )

pure virtual

Sets the default SSID.

Implemented in roo_wifi::ArduinoPreferencesStore.

Referenced by roo_wifi::Controller::connect().

setIsInterfaceEnabled()

virtual void roo_wifi::Store::setIsInterfaceEnabled ( bool  enabled )

pure virtual

Sets whether the Wi-Fi interface is enabled.

Implemented in roo_wifi::ArduinoPreferencesStore.

Referenced by roo_wifi::Controller::toggleEnabled().

setPassword()

virtual void roo_wifi::Store::setPassword ( const std::string &  ssid, roo::string_view  password  )

pure virtual

Stores a password for an SSID.

Implemented in roo_wifi::ArduinoPreferencesStore.

Referenced by roo_wifi::Controller::connect(), and roo_wifi::Controller::setPassword().

---

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

• temp_repos/roo_wifi/src/roo_wifi/hal/store.h