WlanConnection Class Reference

WLAN connection class. More...

#include <WlanConnection.h>

Inheritance diagram for WlanConnection:
NetworkConnection PowerEventListener Thread EventBroadcaster< NetworkEventListener >

List of all members.

Public Member Functions

 WlanConnection (WLAN_CONNECTION_SETTINGS *pSettings)
 Class constructor.
virtual ~WlanConnection ()
 Class destructor.
virtual bool isConnectionUp ()
 Check connection state The implementation must implement this method to return a valid value.
virtual bool getNetworkInfo (GENERIC_NETWORK_INFO &netInfo)
 Get network information.
virtual const char * getLastError ()
 Get last error.

Protected Member Functions

virtual bool netInitialize ()
 Network initialization routine Initializes the network connection.
virtual bool netShutdown ()
 Network shutdown routine Shuts down the network connection.
virtual bool netConnect ()
 Establish network connection Establish connection to the network.
virtual bool netDisconnect ()
 Disconnect from network Disconnects the from the network.
virtual bool netSuspend ()
 Suspend network connection.
virtual bool netResume ()
 Restore network connection.

Detailed Description

WLAN connection class.

Implements the WLAN network connection. Currently supported are the Ralink RT2870 and RT3070 WLAN modules with Ralink drivers.


Constructor & Destructor Documentation

WlanConnection::WlanConnection ( WLAN_CONNECTION_SETTINGS pSettings  ) 

Class constructor.

Initializes the WLAN connection object.

Parameters:
pSettings Points to a structure containing the WLAN configuration parameters. The data is copied to a local storage.
WlanConnection::~WlanConnection (  )  [virtual]

Class destructor.

Terminates the WLAN connection object.


Member Function Documentation

virtual const char* WlanConnection::getLastError (  )  [inline, virtual]

Get last error.

Returns:
Returns the text message associated with a last error occured, NULL if none.

Reimplemented from NetworkConnection.

bool WlanConnection::getNetworkInfo ( GENERIC_NETWORK_INFO netInfo  )  [virtual]

Get network information.

Parameters:
netInfo Address to the structure where to store the retrieved network information The implementation must implement this method to fill the information structure.
Returns:
Returns true if the information was read successfully.

Implements NetworkConnection.

bool WlanConnection::isConnectionUp (  )  [virtual]

Check connection state The implementation must implement this method to return a valid value.

Returns:
Returns true if the network connection is still available.

Implements NetworkConnection.

bool WlanConnection::netConnect (  )  [protected, virtual]

Establish network connection Establish connection to the network.

Returns:
Returns true if network connection was established successfully.

Implements NetworkConnection.

bool WlanConnection::netDisconnect (  )  [protected, virtual]

Disconnect from network Disconnects the from the network.

Returns:
Returns true if network was disconnected successfully.

Implements NetworkConnection.

bool WlanConnection::netResume (  )  [protected, virtual]

Restore network connection.

Called internally when the mobile data terminal leaves a power saving mode. The implementation may override this method to take a specific action.

Returns:
Return true when the connection is restored successfully.

Reimplemented from NetworkConnection.

bool WlanConnection::netShutdown (  )  [protected, virtual]

Network shutdown routine Shuts down the network connection.

Returns:
Returns true if the network connection was shut down successfully.

Implements NetworkConnection.

bool WlanConnection::netSuspend (  )  [protected, virtual]

Suspend network connection.

Called internally when the mobile data terminal enters a power saving mode. The implementation may override this method to take a specific action.

Returns:
Return true when ready to enter a power saving mode. Return false to reject the request and abort power saving.

Reimplemented from NetworkConnection.


The documentation for this class was generated from the following files:
Generated on Wed Oct 20 11:13:45 2010 for libspatha by  doxygen 1.6.3