Driver::Wifi::Station::Connection Class Reference

This class defines an asynchronous interface for a Station device to connect to a WIFI network. More...

Detailed Description

This class defines an asynchronous interface for a Station device to connect to a WIFI network.

This interface does NOT define any thread safety semantics, i.e. the application should assume that the interface is NOT thread safe.

The interface uses polling semantics, i.e. the application is required to call the 'poll()' periodically.

The class/interface is designed a 'Singleton', i.e. the application can only have one instance/implementation of the interface.

#include <Connection.h>

Public Types
enum	State_T {   eLINK_DOWN , eLINK_JOINED , eLINK_JOINED_NOIP , eLINK_UP ,   eLINK_FAILED , eLINK_NO_NETWORK , eLINK_BAD_AUTHENTICATION }
	Connection state. More...
enum	Authentication_T { eOPEN = 0 , eWPA_TKIP_PSK , eWPA2_AES_PSK , eWPA2_MIXED_PSK }
	Authorization options. More...
typedef void(*	StateChangedFunc_T) (State_T currentState)
	Defines the function signature for callbacks.

Static Public Member Functions
static void	initiailize () noexcept
	This method is used to initialize the WIFI engine in Station Mode.
static bool	start (const char *ssid, const char *password, Authentication_T authenticationMethod, StateChangedFunc_T callbackFunc=nullptr) noexcept
	This method is used to initiate connecting to a WIFI network.
static void	poll () noexcept
	This method is used to monitor the current state of the WIFI connection and attempts to re-establish the connect if it drops.
static bool	isConnected () noexcept
	This method returns true if the state of the WIFI connection is in the eLINK_UP state.
static State_T	getState () noexcept
	This method returns true the current state of the WIFI connection.
static void	stop () noexcept
	This method disconnects the device from the from the WIFI network.
static const char *	toString (State_T linkStatus) noexcept
	Convience method that convert the binary State_T enum to string.

Member Typedef Documentation

StateChangedFunc_T

typedef void(* Driver::Wifi::Station::Connection::StateChangedFunc_T) (State_T currentState)

Defines the function signature for callbacks.

Member Enumeration Documentation

Authentication_T

enum Driver::Wifi::Station::Connection::Authentication_T

Authorization options.

Enumerator
eOPEN	No authorization required.
eWPA_TKIP_PSK	WPA authorization.
eWPA2_AES_PSK	WPA2 authorization (preferred)
eWPA2_MIXED_PSK	WPA2/WPA mixed authorization.

State_T

enum Driver::Wifi::Station::Connection::State_T

Connection state.

Enumerator
eLINK_DOWN	The link is down.
eLINK_JOINED	Connected to wifi.
eLINK_JOINED_NOIP	Connected to wifi, but no IP address.
eLINK_UP	Connect to wifi with an IP address.
eLINK_FAILED	Connection failed.
eLINK_NO_NETWORK	No matching SSID found (could be out of range, or down)
eLINK_BAD_AUTHENTICATION	Authentication failure.

Member Function Documentation

getState()

static State_T Driver::Wifi::Station::Connection::getState ( )

staticnoexcept

This method returns true the current state of the WIFI connection.

initiailize()

static void Driver::Wifi::Station::Connection::initiailize ( )

staticnoexcept

This method is used to initialize the WIFI engine in Station Mode.

It should only be called ONCE on startup before any other methods in this interface is called.

This method ASSUMES that the hardware, WIFI stack, etc. has ALREADY been initialized and is available for use.

isConnected()

static bool Driver::Wifi::Station::Connection::isConnected ( )

staticnoexcept

This method returns true if the state of the WIFI connection is in the eLINK_UP state.

poll()

static void Driver::Wifi::Station::Connection::poll ( )

staticnoexcept

This method is used to monitor the current state of the WIFI connection and attempts to re-establish the connect if it drops.

The application is responsible for calling this method periodically.

start()

static bool Driver::Wifi::Station::Connection::start ( const char *  ssid, const char *  password, Authentication_T  authenticationMethod, StateChangedFunc_T  callbackFunc = nullptr  )

staticnoexcept

This method is used to initiate connecting to a WIFI network.

The method will optionally generate callbacks to the application when the state of the connection changes. Note: Callbacks for EVERY transition is NOT guaranteed. What is guaranteed is that latest state change when the poll() method is called will trigger a callback

The 'ssid' and 'password' arguments MUST stay in scope until stop() is called (i.e. the application is responsible for the memory of these arguments).

stop()

static void Driver::Wifi::Station::Connection::stop ( )

staticnoexcept

This method disconnects the device from the from the WIFI network.

The Application must call start() again to reconnect to a/the WIFI network

toString()

static const char * Driver::Wifi::Station::Connection::toString ( State_T  linkStatus )

staticnoexcept

Convience method that convert the binary State_T enum to string.

---

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

• Driver/Wifi/Station/Connection.h