Collapse all Symbian^3 Application Developer Library

MWlanMgmtInterface Class Reference

class MWlanMgmtInterface

ECom interface class for WLAN management services.

This class contains the methods for managing WLAN connections and querying the statuses of various connection variables.

Since: Series 60 3.0

Public Member Functions
void	ActivateExtendedNotificationsL ( MWlanMgmtNotifications &, TUint )
void	ActivateNotificationsL ( MWlanMgmtNotifications &)
TInt	AddBssidToBlacklist (const TWlanBssid &)
TInt	AddIapSsidList ( TUint , const CArrayFixFlat < TWlanSsid > &)
void	CancelCreateTrafficStream ()
void	CancelDeleteTrafficStream ()
void	CancelDirectedRoam ()
void	CancelGetAvailableIaps ()
void	CancelGetScanResults ()
void	CancelNotifications ()
void	CancelProtectedSetup ()
void	CreateTrafficStream ( TRequestStatus &, const TWlanTrafficStreamParameters &, TUint &, TWlanTrafficStreamStatus &)
void	DeleteTrafficStream ( TRequestStatus &, TUint )
void	DirectedRoam ( TRequestStatus &, const TWlanBssid &)
TInt	GetAvailableIaps ( RArray < TUint > &)
void	GetAvailableIaps ( TRequestStatus &, RArray < TUint > &)
void	GetAvailableIaps ( TInt &, TUint &, TRequestStatus &, RArray < TUint > &)
void	GetAvailableIaps ( TInt &, TUint &, TBool , TRequestStatus &, RArray < TWlanIapAvailabilityData > &)
TInt	GetConnectionBssid ( TWlanBssid &)
TInt	GetConnectionMode ( TWlanConnectionMode &)
TInt	GetConnectionSecurityMode ( TWlanConnectionSecurityMode &)
TInt	GetConnectionSignalQuality ( TInt32 &)
TInt	GetConnectionSsid ( TWlanSsid &)
TInt	GetExtendedConnectionSecurityMode ( TWlanConnectionExtentedSecurityMode &)
TInt	GetScanResults ( CWlanScanInfo &)
void	GetScanResults ( TRequestStatus &, CWlanScanInfo &)
void	GetScanResults ( TWlanSsid &, TRequestStatus &, CWlanScanInfo &)
void	GetScanResults ( TInt &, TUint &, TWlanSsid &, TRequestStatus &, CWlanScanInfo &)
void	NotifyChangedSettings ()
TInt	RemoveIapSsidList ( TUint )
void	RunProtectedSetup ( TRequestStatus &, TUint32 , CArrayFixSeg < TWlanProtectedSetupCredentialAttribute > &)
TInt	StartAggressiveBgScan ( TUint )
TInt	UpdateRssNotificationBoundary (const TInt32 , const TInt32 )

Member Functions Documentation

ActivateExtendedNotificationsL(MWlanMgmtNotifications &, TUint)

void	ActivateExtendedNotificationsL	(	MWlanMgmtNotifications &	aCallback,
			TUint	aCallbackInterfaceVersion = KWlanCallbackInterfaceVersion
		)	[pure virtual]

Activate the extended notification service.

After the client has enabled the notification service, it can receive asynchronous notifications from the server.

Parameters

MWlanMgmtNotifications & aCallback	The class that implements the callback interface.
TUint aCallbackInterfaceVersion = KWlanCallbackInterfaceVersion	The callback interface version implemented by the client. This MUST NOT be touched.

ActivateNotificationsL(MWlanMgmtNotifications &)

void

ActivateNotificationsL

(

MWlanMgmtNotifications &

aCallback

)

[pure virtual]

Activate the notification service.

After the client has enabled the notification service, it can receive asynchronous notifications from the server.

Note:

This method only activates notifications defined in callback interface v1.

ActivateExtendedNotificationsL

Parameters

MWlanMgmtNotifications & aCallback

The class that implements the callback interface.

AddBssidToBlacklist(const TWlanBssid &)

TInt

AddBssidToBlacklist

(

const TWlanBssid &

aBssid

)

[pure virtual]

Adds a bssid to the blacklist

Parameters

const TWlanBssid & aBssid

The BSSID of the accesspoint.

AddIapSsidList(TUint, const CArrayFixFlat< TWlanSsid > &)

TInt	AddIapSsidList	(	TUint	aIapId,
			const CArrayFixFlat < TWlanSsid > &	aSsidList
		)	[pure virtual]

Add a list of SSIDs to the given IAP ID.

The list of SSIDs is matched against the scan results during IAP availability check and the corresponding IAP marked as available if a match is found.

Parameters

TUint aIapId	IAP ID the list is attached to.
const CArrayFixFlat < TWlanSsid > & aSsidList	List of SSIDs. Any previous list attached will be overwritten.

CancelCreateTrafficStream()

void

CancelCreateTrafficStream

(

)

[pure virtual]

Cancel an outstanding traffic stream creation request.

CancelDeleteTrafficStream()

void

CancelDeleteTrafficStream

(

)

[pure virtual]

Cancel an outstanding traffic stream deletion request.

CancelDirectedRoam()

void

CancelDirectedRoam

(

)

[pure virtual]

Cancel an outstanding directed roam request.

CancelGetAvailableIaps()

void

CancelGetAvailableIaps

(

)

[pure virtual]

Cancel an outstanding IAP availability request.

CancelGetScanResults()

void

CancelGetScanResults

(

)

[pure virtual]

Cancel an outstanding scan request.

CancelNotifications()

void

CancelNotifications

(

)

[pure virtual]

Cancel the notification service.

CancelProtectedSetup()

void

CancelProtectedSetup

(

)

[pure virtual]

Cancel an outstanding Protected Setup operation.

CreateTrafficStream(TRequestStatus &, const TWlanTrafficStreamParameters &, TUint &, TWlanTrafficStreamStatus &)

void	CreateTrafficStream	(	TRequestStatus &	aStatus,
			const TWlanTrafficStreamParameters &	aStreamParameters,
			TUint &	aStreamId,
			TWlanTrafficStreamStatus &	aStreamStatus
		)	[pure virtual]

Create a virtual traffic stream.

Parameters

TRequestStatus & aStatus	Status of the calling active object. On successful completion contains KErrNone, otherwise one of the system-wide error codes.
const TWlanTrafficStreamParameters & aStreamParameters	Traffic stream parameters to use.
TUint & aStreamId	Contains the ID assigned to this traffic stream on successful completion.
TWlanTrafficStreamStatus & aStreamStatus	Contains the status of the traffic stream on successful completion.

DeleteTrafficStream(TRequestStatus &, TUint)

void	DeleteTrafficStream	(	TRequestStatus &	aStatus,
			TUint	aStreamId
		)	[pure virtual]

Delete a virtual traffic stream.

Parameters

TRequestStatus & aStatus	Status of the calling active object. On successful completion contains KErrNone, otherwise one of the system-wide error codes.
TUint aStreamId	ID of the traffic stream to delete.

DirectedRoam(TRequestStatus &, const TWlanBssid &)

void	DirectedRoam	(	TRequestStatus &	aStatus,
			const TWlanBssid &	aBssid
		)	[pure virtual]

Initiate a roam to the given BSSID.

Parameters

TRequestStatus & aStatus	Status of the calling active object. On successful completion contains KErrNone, otherwise one of the system-wide error codes.
const TWlanBssid & aBssid	BSSID to roam to. If set to FF:FF:FF:FF:FF:FF address, search for a better BSS is initiated.

GetAvailableIaps(RArray< TUint > &)

TInt

GetAvailableIaps

(

RArray < TUint > &

aAvailableIaps

)

[pure virtual]

Get the available WLAN IAPs.

Parameters

RArray < TUint > & aAvailableIaps

Array of IAP IDs available.

GetAvailableIaps(TRequestStatus &, RArray< TUint > &)

void	GetAvailableIaps	(	TRequestStatus &	aStatus,
			RArray < TUint > &	aAvailableIaps
		)	[pure virtual]

Get the available WLAN IAPs.

Parameters

TRequestStatus & aStatus	Status of the calling active object. On successful completion contains KErrNone, otherwise one of the system-wide error codes.
RArray < TUint > & aAvailableIaps	Array of IAP IDs available.

GetAvailableIaps(TInt &, TUint &, TRequestStatus &, RArray< TUint > &)

void	GetAvailableIaps	(	TInt &	aCacheLifetime,
			TUint &	aMaxDelay,
			TRequestStatus &	aStatus,
			RArray < TUint > &	aAvailableIaps
		)	[pure virtual]

Get the available WLAN IAPs.

Parameters

TInt & aCacheLifetime	Defines how many seconds old cached results the client is willing to accept. The valid is range is from 0 to 60 seconds. The value of -1 means the system default will be used. The aCacheLifetime parameter has a meaning only when the aMaxDelay parameter is zero. Value will be changed to the actual value used by the system.
TUint & aMaxDelay	Maximum amount of seconds the client is willing to wait for the availability results. The valid range is from 0 to 1200 seconds or KWlanInfiniteScanDelay. KWlanInfiniteScanDelay will never cause a scan, but the request will be completed when any other broadcast scan request is completed. Value will be changed to the actual value used by the system.
TRequestStatus & aStatus	Status of the calling active object. On successful completion contains KErrNone, otherwise one of the system-wide error codes.
RArray < TUint > & aAvailableIaps	Array of IAP IDs available.

GetAvailableIaps(TInt &, TUint &, TBool, TRequestStatus &, RArray< TWlanIapAvailabilityData > &)

void	GetAvailableIaps	(	TInt &	aCacheLifetime,
			TUint &	aMaxDelay,
			TBool	aFilteredResults,
			TRequestStatus &	aStatus,
			RArray < TWlanIapAvailabilityData > &	aAvailableIaps
		)	[pure virtual]

Get the available WLAN IAPs.

Parameters

TInt & aCacheLifetime	Defines how many seconds old cached results the client is willing to accept. The valid is range is from 0 to 60 seconds. The value of -1 means the system default will be used. The aCacheLifetime parameter has a meaning only when the aMaxDelay parameter is zero. Value will be changed to the actual value used by the system.
TUint & aMaxDelay	Maximum amount of seconds the client is willing to wait for the availability results. The valid range is from 0 to 1200 seconds or KWlanInfiniteScanDelay. KWlanInfiniteScanDelay will never cause a scan, but the request will be completed when any other broadcast scan request is completed. Value will be changed to the actual value used by the system.
TBool aFilteredResults	Whether availability is filtered based on signal strength. ETrue if filtering is allowed, EFalse if not.
TRequestStatus & aStatus	Status of the calling active object. On successful completion contains KErrNone, otherwise one of the system-wide error codes.
RArray < TWlanIapAvailabilityData > & aAvailableIaps	Array of IAPs available.

GetConnectionBssid(TWlanBssid &)

TInt

GetConnectionBssid

(

TWlanBssid &

aBssid

)

[pure virtual]

Get the BSSID of the BSS currently connected to.

Note:

This method can only be used while successfully connected to a WLAN network.

Parameters

TWlanBssid & aBssid

BSSID of the currently connected BSS.

GetConnectionMode(TWlanConnectionMode &)

TInt

GetConnectionMode

(

TWlanConnectionMode &

aMode

)

[pure virtual]

Get the mode of the WLAN connection.

Parameters

TWlanConnectionMode & aMode

The current mode of the connection.

GetConnectionSecurityMode(TWlanConnectionSecurityMode &)

TInt

GetConnectionSecurityMode

(

TWlanConnectionSecurityMode &

aMode

)

[pure virtual]

Get the currently used security mode of the WLAN connection.

Note:

This method can only be used while successfully connected to a WLAN network.

This method is offered for backward compatibility reasons, GetExtendedConnectionSecurityMode() should be used instead.

Parameters

TWlanConnectionSecurityMode & aMode

The security mode of the connection.

GetConnectionSignalQuality(TInt32 &)

TInt

GetConnectionSignalQuality

(

TInt32 &

aSignalQuality

)

[pure virtual]

Get the current Received Signal Strength Indicator (RSSI).

Note:

This method can only be used while successfully connected to a WLAN network.

Parameters

TInt32 & aSignalQuality

Current RSSI.

GetConnectionSsid(TWlanSsid &)

TInt

GetConnectionSsid

(

TWlanSsid &

aSsid

)

[pure virtual]

Get the SSID of the WLAN network currently connected to.

Note:

This method can only be used while successfully connected to a WLAN network.

Parameters

TWlanSsid & aSsid

SSID of the currently connected network.

GetExtendedConnectionSecurityMode(TWlanConnectionExtentedSecurityMode &)

TInt

GetExtendedConnectionSecurityMode

(

TWlanConnectionExtentedSecurityMode &

aMode

)

[pure virtual]

Get the currently used security mode of the WLAN connection.

Note:

This method can only be used while successfully connected to a WLAN network.

Parameters

TWlanConnectionExtentedSecurityMode & aMode

The security mode of the connection.

GetScanResults(CWlanScanInfo &)

TInt

GetScanResults

(

CWlanScanInfo &

aResults

)

[pure virtual]

Perform a broadcast scan and return the detected WLAN networks.

Parameters

CWlanScanInfo & aResults

Results of the scan.

GetScanResults(TRequestStatus &, CWlanScanInfo &)

void	GetScanResults	(	TRequestStatus &	aStatus,
			CWlanScanInfo &	aResults
		)	[pure virtual]

Perform a broadcast scan and return the detected WLAN networks.

Parameters

TRequestStatus & aStatus	Status of the calling active object. On successful completion contains KErrNone, otherwise one of the system-wide error codes.
CWlanScanInfo & aResults	Results of the scan.

GetScanResults(TWlanSsid &, TRequestStatus &, CWlanScanInfo &)

void	GetScanResults	(	TWlanSsid &	aSsid,
			TRequestStatus &	aStatus,
			CWlanScanInfo &	aResults
		)	[pure virtual]

Perform a direct scan for an SSID and return the detected WLAN networks. If the SSID has zero length, a broadcast scan will be done.

Parameters

TWlanSsid & aSsid	name of the WLAN network
TRequestStatus & aStatus	Status of the calling active object. On successful completion contains KErrNone, otherwise one of the system-wide error codes.
CWlanScanInfo & aResults	Results of the scan.

GetScanResults(TInt &, TUint &, TWlanSsid &, TRequestStatus &, CWlanScanInfo &)

void	GetScanResults	(	TInt &	aCacheLifetime,
			TUint &	aMaxDelay,
			TWlanSsid &	aSsid,
			TRequestStatus &	aStatus,
			CWlanScanInfo &	aResults
		)	[pure virtual]

Perform a direct scan for an SSID and return the detected WLAN networks. If the SSID has zero length, a broadcast scan will be done.

Parameters

TInt & aCacheLifetime	Defines how many seconds old cached results the client is willing to accept. The valid is range is from 0 to 60 seconds. The value of -1 means the system default will be used. The aCacheLifetime parameter has a meaning only when the aMaxDelay parameter is zero. Value will be changed to the actual value used by the system.
TUint & aMaxDelay	Maximum amount of seconds the client is willing to wait for the scan results. The valid range is from 0 to 1200 seconds or KWlanInfiniteScanDelay. KWlanInfiniteScanDelay will never cause a scan, but the request will be completed when any other broadcast scan request is completed. Value will be changed to the actual value used by the system.
TWlanSsid & aSsid	Name of the WLAN network.
TRequestStatus & aStatus	Status of the calling active object. On successful completion contains KErrNone, otherwise one of the system-wide error codes.
CWlanScanInfo & aResults	Results of the scan.

NotifyChangedSettings()

void

NotifyChangedSettings

(

)

[pure virtual]

Notify the server about changed WLAN settings.

RemoveIapSsidList(TUint)

TInt

RemoveIapSsidList

(

TUint

aIapId

)

[pure virtual]

Remove any list of SSIDs attached to the given IAP ID.

Parameters

TUint aIapId

IAP ID the list is attached to.

RunProtectedSetup(TRequestStatus &, TUint32, CArrayFixSeg< TWlanProtectedSetupCredentialAttribute > &)

void	RunProtectedSetup	(	TRequestStatus &	aStatus,
			TUint32	aId,
			CArrayFixSeg < TWlanProtectedSetupCredentialAttribute > &	aCredentials
		)	[pure virtual]

Start Protected Setup.

Protected Setup-specific error codes .

Parameters

TRequestStatus & aStatus	Status of the calling active object. On successful completion contains KErrNone, otherwise one of the system-wide error codes.
TUint32 aId	Service ID of network which user has selected to be configured.
CArrayFixSeg < TWlanProtectedSetupCredentialAttribute > & aCredentials	Results of a successful Protected Setup operation.

StartAggressiveBgScan(TUint)

TInt

StartAggressiveBgScan

(

TUint

aInterval

)

[pure virtual]

Start aggressive background scanning.

Parameters

TUint aInterval

Scan interval (in seconds) for aggressive mode.

UpdateRssNotificationBoundary(const TInt32, const TInt32)

TInt	UpdateRssNotificationBoundary	(	const TInt32	aRssLevelBoundary,
			const TInt32	aHysteresis
		)	[pure virtual]

Updates the RSS notification class boundaries.

Parameters

const TInt32 aRssLevelBoundary	Specifies the RSS level when a signal level notification should be given. This boundary is used when signal level is getting worse (see next parameter).
const TInt32 aHysteresis	Specifies the difference between RSS notification trigger levels of declining and improving signal quality, i.e. since aRssLevelBoundary specifies the level boundary for declining signal, the same boundary for improving signal is ( aRssLevelBoundary - aHysteresis ).