WiFi Framework C++ Edition
Public Member Functions | Protected Member Functions | List of all members
CwclNetworkListManager Class Reference

The CwclNetworkListManager class provides a set of methods to perform network list management functions and receives events related to the Network List Manager. More...

#include <wclNlm.h>

Public Member Functions

 CwclNetworkListManager ()
 Creates a new component.
 
virtual ~CwclNetworkListManager ()
 Frees the component.
 
int Close ()
 Closes the Network List Manager and releases all allocated resources.
 
int Open ()
 Opens the Network List Manager and prepares for events receiving.
 
int GetConnected (bool &Connected) const
 Checks if the machine has network connectivity.
 
int GetConnectedToInternet (bool &Connected) const
 Checks if the local machine has Internet connectivity.
 
int GetConnectivity (wclNlmConnectivityFlags &Connectivity) const
 The GetConnectivity method reads the overall connectivity state of the machine.
 
int GetConnections (wclNlmConnections &Connections) const
 The method enumerates a complete list of the network connections that have been made.
 
int GetNetwork (const GUID &NetworkId, CwclNlmNetwork *&Network) const
 The method retrieves a network based on a supplied network ID.
 
int GetNetworks (const wclNlmEnumNetwork Flags, wclNlmNetworks &Networks) const
 Retrieves the list of networks available on the local machine.
 
int DeleteNetwork (const GUID &NetworkId)
 Deletes network profile with given ID.
 
__event void AfterOpen (void *Sender)
 The event fires after Network List Manager opened.
 
__event void BeforeClose (void *Sender)
 The event fires before the Network List Manager closed.
 
__event void OnConnectivityChanged (void *Sender, const wclNlmConnectivityFlags &Connectivity)
 The event fires when network connectivity related changes occur.
 
__event void OnNetworkAdded (void *Sender, const GUID &NetworkId)
 The event fires when a new network is added.
 
__event void OnNetworkConnectivityChanged (void *Sender, const GUID &NetworkId, const wclNlmConnectivityFlags &Connectivity)
 The event fires when network connectivity related changes occur.
 
__event void OnNetworkDeleted (void *Sender, const GUID &NetworkId)
 The event fires when a network is deleted.
 
__event void OnNetworkPropertyChanged (void *Sender, const GUID &NetworkId, const wclNlmNetworkPropertyChangeFlags &Change)
 The event fires when a network property change is detected.
 
__event void OnConnectionConnectivityChanged (void *Sender, const GUID &ConnectionId, const wclNlmConnectivityFlags &Connectivity)
 The OnConnectionConnectivityChanged event handler prototype.
 
__event void OnConnectionPropertyChanged (void *Sender, const GUID &ConnectionId, const wclNlmConnectionProperty Prop)
 The OnConnectionPropertyChanged event handler prototype.
 

Protected Member Functions

virtual void DoAfterOpen ()
 Fires the AfterOpen event.
 
virtual void DoBeforeClose ()
 Fires the BeforeClose event.
 
virtual void DoConnectivityChanged (const wclNlmConnectivityFlags &Connectivity)
 Fires the OnConnectivityChanged event.
 
virtual void DoNetworkAdded (const GUID &NetworkId)
 Fires the OnNetworkAdded event.
 
virtual void DoNetworkConnectivityChanged (const GUID &NetworkId, const wclNlmConnectivityFlags &Connectivity)
 Fires then OnNetworkConnectivityChanged event.
 
virtual void DoNetworkDeleted (const GUID &NetworkId)
 Fires the OnNetworkDeleted event.
 
virtual void DoNetworkPropertyChanged (const GUID &NetworkId, const wclNlmNetworkPropertyChangeFlags &Change)
 Fires the OnNetworkPropertyChanged event.
 
virtual void DoConnectionConnectivityChanged (const GUID &ConnectionId, const wclNlmConnectivityFlags &Connectivity)
 Fires the OnConnectionConnectivityChanged event.
 
virtual void DoConnectionPropertyChanged (const GUID &ConnectionId, const wclNlmConnectionProperty Prop)
 Fires the OnConnectionPropertyChanged event.
 

Detailed Description

The CwclNetworkListManager class provides a set of methods to perform network list management functions and receives events related to the Network List Manager.

The component is not thread safe.