Collapse all Symbian^3 Product Developer Library

ScanInfo Class Reference

class ScanInfo : public ScanListIterator

Wrapper class to parse data fields from scan info.

Inherits from

ScanInfo
- ScanListIterator

Public Member Functions
	ScanInfo(const ScanList &)
void	BSSID(u8_t)
u16_t	BeaconInterval()
u16_t	Capability()
WlanScanError	FirstIE(u8_t &, u8_t &, const u8_t **)
WlanScanError	InformationElement(u8_t, u8_t &, const u8_t **)
WlanScanError	InformationElement(u8_t, const WlanIeOui &, u8_t, u8_t &, const u8_t **)
WlanScanError	InformationElement(u8_t, const WlanIeOui &, u8_t, u8_t, u8_t &, const u8_t **)
bool_t	IsProtectedSetupSupported()
WlanScanError	NextIE(u8_t &, u8_t &, const u8_t **)
WlanOperatingMode	OperatingMode()
bool_t	Privacy()
u8_t	RXLevel()
WlanSecurityMode	SecurityMode()
u8_t	SignalNoiseRatio()
void	Timestamp(u8_t)
WlanScanError	WpaIE(u8_t &, const u8_t **)

Private Member Functions
	ScanInfo(const ScanInfo &)
WlanScanError	CurrentIE(u8_t &, u8_t &, const u8_t **)
bool_t	IsApSetupLocked(const u8_t *, const u8_t)
ScanInfo &	operator=(const ScanInfo &)

Inherited Functions
	ScanListIterator::Current()const
	ScanListIterator::First()
	ScanListIterator::IsDone()const
	ScanListIterator::Next()
	ScanListIterator::ScanListIterator(const ScanList &)
	ScanListIterator::Size()const

Private Attributes
const u8_t *	ie_iter_m

Inherited Attributes
	ScanListIterator::current_m

Constructor & Destructor Documentation

ScanInfo(const ScanList &)

ScanInfo

(

const ScanList &

scan_list

)

C++ constructor.

Parameters

const ScanList & scan_list

Reference to the scan list container.

ScanInfo(const ScanInfo &)

ScanInfo

(

const ScanInfo &

)

[private]

Prohibit copy constructor.

Parameters

const ScanInfo &

Member Functions Documentation

BSSID(u8_t)

void

BSSID

(

u8_t

bssid

)

const [inline]

Return BSSID of the BSS.

Parameters

u8_t bssid

BSSID of the BSS.

BeaconInterval()

u16_t

BeaconInterval

(

)

const [inline]

Return the beacon interval of the BSS.

Capability()

u16_t

Capability

(

)

const [inline]

Return the capability information of the BSS.

CurrentIE(u8_t &, u8_t &, const u8_t **)

WlanScanError	CurrentIE	(	u8_t &	ie_id,
			u8_t &	ie_length,
			const u8_t **	ie_data
		)	const [private]

Return current information element.

Parameters

u8_t & ie_id	Element ID of the information element.
u8_t & ie_length	Length of the IE. Zero if IE not found.
const u8_t ** ie_data	Pointer to the beginning of the IE data. NULL if IE not found.

FirstIE(u8_t &, u8_t &, const u8_t **)

WlanScanError	FirstIE	(	u8_t &	ie_id,
			u8_t &	ie_length,
			const u8_t **	ie_data
		)

Return the first information element.

Parameters

u8_t & ie_id	Element ID of the information element.
u8_t & ie_length	Length of the IE. Zero if IE not found.
const u8_t ** ie_data	Pointer to the beginning of the IE data. NULL if IE not found.

InformationElement(u8_t, u8_t &, const u8_t **)

WlanScanError	InformationElement	(	u8_t	ie_id,
			u8_t &	ie_length,
			const u8_t **	ie_data
		)

Return the requested information element.

Parameters

u8_t ie_id	Element ID of the information element.
u8_t & ie_length	Length of the IE. Zero if IE not found.
const u8_t ** ie_data	Pointer to the beginning of the IE data. NULL if IE not found.

InformationElement(u8_t, const WlanIeOui &, u8_t, u8_t &, const u8_t **)

WlanScanError	InformationElement	(	u8_t	ie_id,
			const WlanIeOui &	ie_oui,
			u8_t	ie_oui_type,
			u8_t &	ie_length,
			const u8_t **	ie_data
		)

Return the first information element with given OUI and OUI type.

Parameters

u8_t ie_id	Element ID of the information element.
const WlanIeOui & ie_oui	OUI element of the requested IE.
u8_t ie_oui_type	OUI type element of the requested IE.
u8_t & ie_length	Length of the IE. Zero if IE not found.
const u8_t ** ie_data	Pointer to the beginning of the IE data. NULL if IE not found.

InformationElement(u8_t, const WlanIeOui &, u8_t, u8_t, u8_t &, const u8_t **)

WlanScanError	InformationElement	(	u8_t	ie_id,
			const WlanIeOui &	ie_oui,
			u8_t	ie_oui_type,
			u8_t	ie_oui_subtype,
			u8_t &	ie_length,
			const u8_t **	ie_data
		)

Return the first information element with given OUI, OUI type and OUI subtype.

Parameters

u8_t ie_id	Element ID of the information element.
const WlanIeOui & ie_oui	OUI element of the requested IE.
u8_t ie_oui_type	OUI type element of the requested IE.
u8_t ie_oui_subtype	OUI subtype element of the requested IE.
u8_t & ie_length	Length of the IE. Zero if IE not found.
const u8_t ** ie_data	Pointer to the beginning of the IE data. NULL if IE not found.

IsApSetupLocked(const u8_t *, const u8_t)

bool_t	IsApSetupLocked	(	const u8_t *	ie_data,
			const u8_t	ie_length
		)	const [private]

Search through WSC IE and return value of AP setup locked attribute.

Parameters

const u8_t * ie_data	Pointer to the beginning of the IE data.
const u8_t ie_length	Length of the IE.

IsProtectedSetupSupported()

bool_t

IsProtectedSetupSupported

(

)

Check whether Wi-Fi Protected Setup is supported.

NextIE(u8_t &, u8_t &, const u8_t **)

WlanScanError	NextIE	(	u8_t &	ie_id,
			u8_t &	ie_length,
			const u8_t **	ie_data
		)

Return next information element.

Parameters

u8_t & ie_id	Element ID of the information element.
u8_t & ie_length	Length of the IE. Zero if IE not found.
const u8_t ** ie_data	Pointer to the beginning of the IE data. NULL if IE not found.

OperatingMode()

WlanOperatingMode

OperatingMode

(

)

const [inline]

Return the operating mode of the BSS.

Privacy()

bool_t

Privacy

(

)

const [inline]

Return whether the privacy bit is enabled in BSs capabilities.

RXLevel()

u8_t

RXLevel

(

)

const [inline]

Return the measured Received Channel Power Indicator value of the BSS.

SecurityMode()

WlanSecurityMode

SecurityMode

(

)

Return the security mode of the BSS.

SignalNoiseRatio()

u8_t

SignalNoiseRatio

(

)

const [inline]

Return the measured signal noise ratio of the BSS.

Timestamp(u8_t)

void

Timestamp

(

u8_t

timestamp

)

const [inline]

Return the timestamp (TSF) of the BSS.

Parameters

u8_t timestamp

Timestamp of the BSS.

WpaIE(u8_t &, const u8_t **)

WlanScanError	WpaIE	(	u8_t &	ie_length,
			const u8_t **	ie_data
		)

Return the WPA information element.

Parameters

u8_t & ie_length	Length of the IE. Zero if IE not found.
const u8_t ** ie_data	Pointer to the beginning of the IE data. NULL if IE not found.

operator=(const ScanInfo &)

ScanInfo &

operator=

(

const ScanInfo &

)

[private]

Prohibit assigment operator.

Parameters

const ScanInfo &

Member Data Documentation

const u8_t * ie_iter_m

const u8_t *

ie_iter_m

[private]

Iterator for going through IEs of scan info.