Collapse all Symbian^3 Product Developer Library

CConnMonWlanNetwork Class Reference

class CConnMonWlanNetwork : public CBase

Class to represent a WLAN. Used when reporting WLAN scan results back to a client.

Inherits from

CConnMonWlanNetwork
- CBase

Public Member Functions
	~CConnMonWlanNetwork()
IMPORT_C TInt	CompareBySignal(const CConnMonWlanNetwork &, const CConnMonWlanNetwork &)
TUint	ConnectionMode()
IMPORT_C TInt	FromPtrC(const TPtrC &, CConnMonWlanNetwork *)
TBuf< KMaxNameLength >	Name()
IMPORT_C CConnMonWlanNetwork *	NewL(const TBuf< KMaxNameLength > &, TUint, TUint, TUint, const TBuf8< KWlanBssId > &, const TDesC &)
IMPORT_C CConnMonWlanNetwork *	NewL()
IMPORT_C CConnMonWlanNetwork *	NewL(CConnMonWlanNetwork &)
TUint	SecurityMode()
TUint	SignalStrength()
IMPORT_C const HBufC *	ToBuf()
HBufC *	VendorData()
TBuf8< KWlanBssId >	WlanBssid()
IMPORT_C CConnMonWlanNetwork &	operator=(CConnMonWlanNetwork &)

Private Member Functions
	CConnMonWlanNetwork()
	CConnMonWlanNetwork(const TBuf< KMaxNameLength > &, TUint, TUint, TUint, const TBuf8< KWlanBssId > &, const TDesC &)
void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Public Attributes
const TUint	KExtraCount
const TUint	KMaxNameLength
const TUint	KWlanBssId

Private Attributes
TUint	iConnectionMode
TUint	iExtraBuf
TBuf< KMaxNameLength >	iName
TUint	iSecurityMode
TUint	iSignalStrength
HBufC *	iVendorData
TBuf8< KWlanBssId >	iWlanBssId

Constructor & Destructor Documentation

CConnMonWlanNetwork()

CConnMonWlanNetwork

(

)

[private]

Constructor.

CConnMonWlanNetwork(const TBuf< KMaxNameLength > &, TUint, TUint, TUint, const TBuf8< KWlanBssId > &, const TDesC &)

CConnMonWlanNetwork	(	const TBuf< KMaxNameLength > &	aName,
		TUint	aConnectionMode,
		TUint	aSignalStrength,
		TUint	aSecurityMode,
		const TBuf8< KWlanBssId > &	aBssId,
		const TDesC &	aVendorData
	)	[private]

Constructor.

Parameters

const TBuf< KMaxNameLength > & aName	Name (SSID) of the network.
TUint aConnectionMode	Mode of the network.
TUint aSignalStrength	Signal strength of the network.
TUint aSecurityMode	Security mode of the network.
const TBuf8< KWlanBssId > & aBssId	Mac address (BSSID) of the base station.
const TDesC & aVendorData	Not in use.

~CConnMonWlanNetwork()

IMPORT_C

~CConnMonWlanNetwork

(

)

Destructor.

Member Functions Documentation

CompareBySignal(const CConnMonWlanNetwork &, const CConnMonWlanNetwork &)

IMPORT_C TInt	CompareBySignal	(	const CConnMonWlanNetwork &	aFirst,
			const CConnMonWlanNetwork &	aSecond
		)	[static]

Compares two networks by signal strength.

Parameters

const CConnMonWlanNetwork & aFirst	Reference to first WLAN object.
const CConnMonWlanNetwork & aSecond	Reference to second WLAN object.

ConnectionMode()

TUint

ConnectionMode

(

)

[inline]

Obtains the connection mode of the network.

ConstructL()

void

ConstructL

(

)

[private]

Second-phase constructor.

FromPtrC(const TPtrC &, CConnMonWlanNetwork *)

IMPORT_C TInt	FromPtrC	(	const TPtrC &	aPtrC,
			CConnMonWlanNetwork *	aConnMonWlanNetwork
		)	[static]

Reads object of class CConnMonWlanNetwork from memory.

Parameters

const TPtrC & aPtrC	Pointer to the beginning of the CConnMonWlanNetwork object in buffer.
CConnMonWlanNetwork * aConnMonWlanNetwork	Pointer to CConnMonWlanNetwork object where unpacked contents are written.

Name()

TBuf< KMaxNameLength >

Name

(

)

[inline]

Obtains the name (SSID) of the network.

NewL(const TBuf< KMaxNameLength > &, TUint, TUint, TUint, const TBuf8< KWlanBssId > &, const TDesC &)

IMPORT_C CConnMonWlanNetwork *	NewL	(	const TBuf< KMaxNameLength > &	aName,
			TUint	aConnectionMode,
			TUint	aSignalStrength,
			TUint	aSecurityMode,
			const TBuf8< KWlanBssId > &	aBssId,
			const TDesC &	aVendorData
		)	[static]

Constructor.

Parameters

const TBuf< KMaxNameLength > & aName	Name (SSID) of the network.
TUint aConnectionMode	Mode of the network.
TUint aSignalStrength	Signal strength of the network.
TUint aSecurityMode	Security mode of the network.
const TBuf8< KWlanBssId > & aBssId	Mac address (BSSID) of the base station.
const TDesC & aVendorData	Not in use.

NewL()

IMPORT_C CConnMonWlanNetwork *

NewL

(

)

[static]

Constructor.

NewL(CConnMonWlanNetwork &)

IMPORT_C CConnMonWlanNetwork *

NewL

(

CConnMonWlanNetwork &

aConnMonWlanNetwork

)

[static]

Copy constructor.

Parameters

CConnMonWlanNetwork & aConnMonWlanNetwork

The object which is copied.

SecurityMode()

TUint

SecurityMode

(

)

[inline]

Obtains the security mode of the network.

SignalStrength()

TUint

SignalStrength

(

)

[inline]

Obtains the signal strength of the network.

ToBuf()

IMPORT_C const HBufC *

ToBuf

(

)

const

Writes object of class CConnMonWlanNetwork to memory. Ownership of newly created buffer is transferred to caller.

VendorData()

HBufC *

VendorData

(

)

[inline]

Obtains a pointer to vendor specific data buffer. Ownership of the data is NOT transferred. Not in use, use package attribute KWlanProbeRawBuffers instead.

WlanBssid()

TBuf8< KWlanBssId >

WlanBssid

(

)

[inline]

Obtains the mac address (BSSID) of the base station.

operator=(CConnMonWlanNetwork &)

IMPORT_C CConnMonWlanNetwork &

operator=

(

CConnMonWlanNetwork &

aConnMonWlanNetwork

)

Assignment operator.

Parameters

CConnMonWlanNetwork & aConnMonWlanNetwork

The object which is assigned.

Member Data Documentation

const TUint KExtraCount

const TUint

KExtraCount

[static]

Reserved for future use.

const TUint KMaxNameLength

const TUint

KMaxNameLength

[static]

Maximum length of a WLAN name (SSID).

const TUint KWlanBssId

const TUint

KWlanBssId

[static]

WLAN BSSID length (mac address).

TUint iConnectionMode

TUint

iConnectionMode

[private]

TUint iExtraBuf

TUint

iExtraBuf

[private]

TBuf< KMaxNameLength > iName

TBuf< KMaxNameLength >

iName

[private]

TUint iSecurityMode

TUint

iSecurityMode

[private]

TUint iSignalStrength

TUint

iSignalStrength

[private]

HBufC * iVendorData

HBufC *

iVendorData

[private]

TBuf8< KWlanBssId > iWlanBssId

TBuf8< KWlanBssId >

iWlanBssId

[private]