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

The component represents the WiFi Direct Legacy Soft AP. More...

#include <wclWiFi.h>

Public Member Functions

 CwclWiFiSoftAP ()
 Creates a new WiFi Soft AP component.
 
virtual ~CwclWiFiSoftAP ()
 Frees the component.
 
int Start (const tstring &Ssid, const tstring &Passphrase)
 Starts the WiFi Direct Legacy Soft AP.
 
int Start (const tstring &Ssid)
 Starts the WiFi Direct Legacy Soft AP in Open Authentication (Open Network) mode.
 
int Stop ()
 Stops the WiFi Direct Legacy Soft AP.
 
int GetPassphrase (tstring &Passphrase) const
 Reads the Soft AP passphrase.
 
int GetSsid (tstring &Ssid) const
 Reads the Soft AP SSID.
 
int GetIpSettings (tstring &Address, tstring &Mask, tstring &Gateway, tstring &Dns1, tstring &Dns2) const
 Gets current IP settings.
 
int SetIpSettings (const tstring &Address, const tstring &Mask, const tstring &Gateway, const tstring &Dns1, const tstring &Dns2)
 Sets current IP settings.
 
int ResetIpSettings ()
 Resets IP settings to its system default values.
 
bool GetActive () const
 Gets the Soft AP status.
 
 __declspec (property(get=GetActive)) bool Active
 Gets the Soft AP status.
 
__event void OnDeviceAccept (void *Sender, CwclWiFiDirectDevice *const Device, bool &Accept)
 The event fires when new device is trying to connected to the WiFI Direct Soft AP.
 
__event void OnDeviceConnected (void *Sender, CwclWiFiDirectDevice *const Device)
 The event fires when new device is connected to the WiFI Direct Soft AP.
 
__event void OnDeviceConnectError (void *Sender, CwclWiFiDirectDevice *const Device, const int Error)
 The event fires when new device is connected to the WiFI Direct Soft AP.
 
__event void OnDeviceDisconnected (void *Sender, CwclWiFiDirectDevice *const Device)
 The event fires when the WiFi Direct device is disconnected from the WiFI Direct Soft AP.
 
__event void OnStarted (void *Sender)
 The event fires when the Soft AP has been started with success.
 
__event void OnStopped (void *Sender)
 The event fires when the Soft AP has been stopped.
 

Protected Member Functions

virtual void DoDeviceAccept (CwclWiFiDirectDevice *const Device, bool &Accept)
 Fires the OnDeviceAccept event.
 
virtual void DoDeviceConnected (CwclWiFiDirectDevice *const Device)
 Fires the OnDeviceConnected event.
 
virtual void DoDeviceConnectError (CwclWiFiDirectDevice *const Device, const int Error)
 Fires the OnDeviceConnectError event.
 
virtual void DoDeviceDisconnected (CwclWiFiDirectDevice *const Device)
 Fires the OnDeviceDisconnected event.
 
virtual void DoStarted ()
 Fires the OnStarted event.
 
virtual void DoStopped ()
 Fires the OnStopped event.
 

Detailed Description

The component represents the WiFi Direct Legacy Soft AP.

An application can use the TwclWiFiSoftAP component if needs to run Hosted Network (Legacy Soft AP) on a WiFi adapter that does not support Native WiFi Hosted network features and supports only WiFi Direct features.

On other adapters that supports Native WiFi Hosted Network it is recommended to use the CwclWiFiHostedNetwork component instead.

See also
CwclWiFiHostedNetwork