Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
CC32xxWiFiInterface Class Referenceabstract

Interface that aids in unit testing. More...

#include <CC32xxWiFi.hxx>

Inheritance diagram for CC32xxWiFiInterface:
CC32xxWiFi CC32xxWiFi

Public Types

enum  SecurityType {
  SEC_OPEN , SEC_WEP , SEC_WPA2 , SEC_OPEN ,
  SEC_WEP , SEC_WPA2
}
 Security types. More...
 
enum  SecurityType {
  SEC_OPEN , SEC_WEP , SEC_WPA2 , SEC_OPEN ,
  SEC_WEP , SEC_WPA2
}
 Security types. More...
 

Protected Member Functions

virtual ~CC32xxWiFiInterface ()
 Destructor.
 
virtual void wlan_setup_ap (const char *ssid, const char *security_key, SecurityType security_type)=0
 Setup access point role credentials.
 
virtual int wlan_profile_del (int index)=0
 Delete a saved WLAN profile.
 
virtual ~CC32xxWiFiInterface ()
 Destructor.
 
virtual void wlan_setup_ap (const char *ssid, const char *security_key, SecurityType security_type)=0
 Setup access point role credentials.
 
virtual int wlan_profile_del (int index)=0
 Delete a saved WLAN profile.
 

Detailed Description

Interface that aids in unit testing.

Definition at line 51 of file net_cc3220/CC32xxWiFi.hxx.

Member Enumeration Documentation

◆ SecurityType [1/2]

Security types.

Enumerator
SEC_OPEN 

open (no security)

SEC_WEP 

WEP security mode.

SEC_WPA2 

WPA2 security mode.

SEC_OPEN 

open (no security)

SEC_WEP 

WEP security mode.

SEC_WPA2 

WPA2 security mode.

Definition at line 56 of file net_cc3220/CC32xxWiFi.hxx.

◆ SecurityType [2/2]

Security types.

Enumerator
SEC_OPEN 

open (no security)

SEC_WEP 

WEP security mode.

SEC_WPA2 

WPA2 security mode.

SEC_OPEN 

open (no security)

SEC_WEP 

WEP security mode.

SEC_WPA2 

WPA2 security mode.

Definition at line 56 of file net_cc32xx/CC32xxWiFi.hxx.

Constructor & Destructor Documentation

◆ ~CC32xxWiFiInterface() [1/2]

virtual CC32xxWiFiInterface::~CC32xxWiFiInterface ( )
inlineprotectedvirtual

Destructor.

Definition at line 66 of file net_cc3220/CC32xxWiFi.hxx.

◆ ~CC32xxWiFiInterface() [2/2]

virtual CC32xxWiFiInterface::~CC32xxWiFiInterface ( )
inlineprotectedvirtual

Destructor.

Definition at line 66 of file net_cc32xx/CC32xxWiFi.hxx.

Member Function Documentation

◆ wlan_profile_del() [1/2]

virtual int CC32xxWiFiInterface::wlan_profile_del ( int  index)
protectedpure virtual

Delete a saved WLAN profile.

Parameters
indexindex within saved profile list to remove, 0xFF removes all
Returns
0 upon success, else -1 on error

Implemented in CC32xxWiFi, and CC32xxWiFi.

◆ wlan_profile_del() [2/2]

virtual int CC32xxWiFiInterface::wlan_profile_del ( int  index)
protectedpure virtual

Delete a saved WLAN profile.

Parameters
indexindex within saved profile list to remove, 0xFF removes all
Returns
0 upon success, else -1 on error

Implemented in CC32xxWiFi, and CC32xxWiFi.

◆ wlan_setup_ap() [1/2]

virtual void CC32xxWiFiInterface::wlan_setup_ap ( const char *  ssid,
const char *  security_key,
SecurityType  security_type 
)
protectedpure virtual

Setup access point role credentials.

It is OK to leave ssid as nullptr or password as nullptr, in which case those properties will not be changed.

Parameters
ssidaccess point ssid (name)
security_keyaccess point security key (password)
security_typespecifies security type. Required.

Implemented in CC32xxWiFi, and CC32xxWiFi.

◆ wlan_setup_ap() [2/2]

virtual void CC32xxWiFiInterface::wlan_setup_ap ( const char *  ssid,
const char *  security_key,
SecurityType  security_type 
)
protectedpure virtual

Setup access point role credentials.

It is OK to leave ssid as nullptr or password as nullptr, in which case those properties will not be changed.

Parameters
ssidaccess point ssid (name)
security_keyaccess point security key (password)
security_typespecifies security type. Required.

Implemented in CC32xxWiFi, and CC32xxWiFi.


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