Collapse all Symbian^3 Product Developer Library

CWlmScanRequest Class Reference

class CWlmScanRequest : public CActive

Active Object for asynchronous scan request.

This class implements an Active Object that is used for handling an asynchronous scan request.

Since: S60 v5.0

Inherits from

CWlmScanRequest
- CActive
  - CBase

Public Member Functions
	~CWlmScanRequest()
TRequestStatus *	ClientStatus()
void	DoCancel()
TInt	IssueRequest(ScanList &, const TDesC8 &, TInt &, TUint &, TRequestStatus *)
CWlmScanRequest *	NewL(RWLMServer &)
TInt	RunError(TInt)
void	RunL()

Private Member Functions
	CWlmScanRequest(RWLMServer &)
void	ConstructL()
TInt	UpdateResults()

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Inherited Enumerations
	CActive:TPriority

Private Attributes
TInt *	iCacheLifetime
RWLMServer &	iClient
TRequestStatus *	iClientStatus
TPckgBuf< TDynamicScanList >	iDynamicScanListBuf
TUint *	iMaxDelay
ScanList *	iScanList
TPtr8	iScanListPtr
TPckgBuf< TScanScheduling >	iScanSchedulingBuf
TPckgBuf< TSSID >	iSsidBuf

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CWlmScanRequest(RWLMServer &)

CWlmScanRequest

(

RWLMServer &

aClient

)

[private]

Constructor

Parameters

RWLMServer & aClient

Handle to client-side interface to WLAN engine.

~CWlmScanRequest()

~CWlmScanRequest

(

)

[virtual]

Destructor.

Member Functions Documentation

ClientStatus()

TRequestStatus *

ClientStatus

(

)

Return the request status of the client.

Since: S60 v5.0

ConstructL()

void

ConstructL

(

)

[private]

Second-phase constructor.

DoCancel()

void

DoCancel

(

)

[virtual]

From CActive. Called by the framework as part of AO's Cancel().

Since: S60 v5.0

IssueRequest(ScanList &, const TDesC8 &, TInt &, TUint &, TRequestStatus *)

TInt	IssueRequest	(	ScanList &	aScanList,
			const TDesC8 &	aSsid,
			TInt &	aCacheLifetime,
			TUint &	aMaxDelay,
			TRequestStatus *	aStatus
		)

Issue a scan request.

Since: S60 v5.0

Parameters

ScanList & aScanList	ScanList used for storing the results.
const TDesC8 & aSsid	SSID used for scanning.
TInt & aCacheLifetime	how old cached results (in seconds) the client is willing to accept.
TUint & aMaxDelay	maximum time (in seconds) the client is willing to wait for the scan results.
TRequestStatus * aStatus	Request status of the client that will be completed when scan has been completed. NULL if synchronous request.

NewL(RWLMServer &)

CWlmScanRequest *

NewL

(

RWLMServer &

aClient

)

[static]

Factory method for creating CWlmScanRequest instance.

Parameters

RWLMServer & aClient

Handle to client-side interface to WLAN engine.

RunError(TInt)

TInt

RunError

(

TInt

aError

)

[virtual]

From CActive. Called by the framework if RunL leaves.

Since: S60 v5.0

Parameters

TInt aError

The error code RunL leaved with.

RunL()

void

RunL

(

)

[virtual]

From CActive. Called when the request has been completed.

Since: S60 v5.0

UpdateResults()

TInt

UpdateResults

(

)

[private]

Updates the scan list contents after a successful scan.

Member Data Documentation

TInt * iCacheLifetime

TInt *

iCacheLifetime

[private]

Pointer to cache lifetime parameter. Not owned by this pointer.

RWLMServer & iClient

RWLMServer &

iClient

[private]

Handle to client-side interface.

TRequestStatus * iClientStatus

TRequestStatus *

iClientStatus

[private]

Request status of the client. Not owned by this pointer.

TPckgBuf< TDynamicScanList > iDynamicScanListBuf

TPckgBuf< TDynamicScanList >

iDynamicScanListBuf

[private]

Buffer for storing scan list count and scan list size.

TUint * iMaxDelay

TUint *

iMaxDelay

[private]

Pointer to max delay parameter. Not owned by this pointer.

ScanList * iScanList

ScanList *

iScanList

[private]

Scan list used for storing the results. Not owned by this pointer.

TPtr8 iScanListPtr

TPtr8

iScanListPtr

[private]

Descriptor for scan list.

TPckgBuf< TScanScheduling > iScanSchedulingBuf

TPckgBuf< TScanScheduling >

iScanSchedulingBuf

[private]

Buffer for storing scan scheduling parameters

TPckgBuf< TSSID > iSsidBuf

TPckgBuf< TSSID >

iSsidBuf

[private]

SSID user for scanning.