Collapse all Symbian^3 Product Developer Library

CBluetoothPhysicalLinkMetrics Class Reference

class CBluetoothPhysicalLinkMetrics : public CBase

Class to subscribe to physical link metrics

Inherits from

CBluetoothPhysicalLinkMetrics
- CBase

Public Member Functions
	~CBluetoothPhysicalLinkMetrics()
IMPORT_C void	Cancel()
void	FailedContactCounterChanged(TUint16)
void	LinkQualityChanged(TUint8)
IMPORT_C CBluetoothPhysicalLinkMetrics *	NewL(MBluetoothPhysicalLinkMetricsObserver &, RSocketServ &, RSocket &)
IMPORT_C CBluetoothPhysicalLinkMetrics *	NewL(MBluetoothPhysicalLinkMetricsObserver &, RSocketServ &, const TBTDevAddr &)
void	RssiChanged(TInt8)
void	SubscribeError(TInt)
IMPORT_C void	SubscribeFailedContactCounter()
IMPORT_C void	SubscribeLinkQuality()
IMPORT_C void	SubscribeRssi()
IMPORT_C void	SubscribeTransmitPowerLevel()
void	TransmitPowerLevelChanged(TInt8)

Private Member Functions
	CBluetoothPhysicalLinkMetrics(MBluetoothPhysicalLinkMetricsObserver &)
void	ConstructL(RSocketServ &, T &)

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()

Private Attributes
CBluetoothPhysicalLinkMetricSubscriber *	iFailedContactCounterBaseband
CBluetoothPhysicalLinkMetricSubscriber *	iLinkQualityBaseband
MBluetoothPhysicalLinkMetricsObserver &	iObserver
CBluetoothPhysicalLinkMetricSubscriber *	iRssiBaseband
CBluetoothPhysicalLinkMetricSubscriber *	iTransmitPowerLevelBaseband

Constructor & Destructor Documentation

CBluetoothPhysicalLinkMetrics(MBluetoothPhysicalLinkMetricsObserver &)

CBluetoothPhysicalLinkMetrics

(

MBluetoothPhysicalLinkMetricsObserver &

aObserver

)

[private]

Parameters

MBluetoothPhysicalLinkMetricsObserver & aObserver

~CBluetoothPhysicalLinkMetrics()

IMPORT_C

~CBluetoothPhysicalLinkMetrics

(

)

Destructor

Member Functions Documentation

Cancel()

IMPORT_C void

Cancel

(

)

Cancels subscriptions to all physical link notifications.

ConstructL(RSocketServ &, T &)

void	ConstructL	(	RSocketServ &	aSockServ,
			T &	aLinkIdentifier
		)	[private]

Parameters

RSocketServ & aSockServ
T & aLinkIdentifier

FailedContactCounterChanged(TUint16)

void

FailedContactCounterChanged

(

TUint16

aFailedContactCounter

)

Parameters

TUint16 aFailedContactCounter

LinkQualityChanged(TUint8)

void

LinkQualityChanged

(

TUint8

aLinkQuality

)

Parameters

TUint8 aLinkQuality

NewL(MBluetoothPhysicalLinkMetricsObserver &, RSocketServ &, RSocket &)

IMPORT_C CBluetoothPhysicalLinkMetrics *	NewL	(	MBluetoothPhysicalLinkMetricsObserver &	aObserver,
			RSocketServ &	aSockServ,
			RSocket &	aConnectedSocket
		)	[static]

Creates a new CBluetoothPhysicalLinkMetrics object from a connected socket

Parameters

MBluetoothPhysicalLinkMetricsObserver & aObserver	The object which will receive asynchronous events
RSocketServ & aSockServ	A handle to an existing session on the socket server (ESock).
RSocket & aConnectedSocket	An open connected socket (ESock subsession) on that existing ESock session

NewL(MBluetoothPhysicalLinkMetricsObserver &, RSocketServ &, const TBTDevAddr &)

IMPORT_C CBluetoothPhysicalLinkMetrics *	NewL	(	MBluetoothPhysicalLinkMetricsObserver &	aObserver,
			RSocketServ &	aSockServ,
			const TBTDevAddr &	aAddr
		)	[static]

Creates a new CBluetoothPhysicalLinkMetrics object from a connected socket

Parameters

MBluetoothPhysicalLinkMetricsObserver & aObserver	The object which will receive asynchronous events
RSocketServ & aSockServ	A handle to an existing session on the socket server (ESock).
const TBTDevAddr & aAddr	The Bluetooth address of a remote device with which there is an existing connection

RssiChanged(TInt8)

void

RssiChanged

(

TInt8

aRssi

)

Parameters

TInt8 aRssi

SubscribeError(TInt)

void

SubscribeError

(

TInt

aError

)

Parameters

TInt aError

SubscribeFailedContactCounter()

IMPORT_C void

SubscribeFailedContactCounter

(

)

Subscribes for notification of changes to the Failed Contact counter of the link. MBluetoothPhysicalLinkMetricsObserver::MbplmoFailedContactCounterChanged will be called with the initial value, then subsequently every time the failed contact counter changes, subject to the polling interval specified in the stack. The stack will continue to run a timer to poll the hardware until the physical link is disconnected or CBluetoothPhysicalLinkMetrics::Cancel is called

SubscribeLinkQuality()

IMPORT_C void

SubscribeLinkQuality

(

)

Subscribes for notification of changes to the Link Quality. MBluetoothPhysicalLinkMetricsObserver::MbplmoLinkQualityChanged will be called with the initial value, then subsequently every time the link quality changes, subject to the polling interval specified in the stack. The stack will continue to run a timer to poll the hardware until the physical link is disconnected or CBluetoothPhysicalLinkMetrics::Cancel is called

SubscribeRssi()

IMPORT_C void

SubscribeRssi

(

)

Subscribes for notification of changes to the RSSI (Received Signal Strengh Indication) of the link. MBluetoothPhysicalLinkMetricsObserver::MbplmoRssiChanged will be called with the initial value, then subsequently every time the RSSI changes, subject to the polling interval specified in the stack. The stack will continue to run a timer to poll the hardware until the physical link is disconnected or CBluetoothPhysicalLinkMetrics::Cancel is called

SubscribeTransmitPowerLevel()

IMPORT_C void

SubscribeTransmitPowerLevel

(

)

Subscribes for notification of changes to the Transmit Power Level of the link. MBluetoothPhysicalLinkMetricsObserver::MbplmoTransmitPowerLevelChanged will be called with the initial value, then subsequently every time the transmit power level changes, subject to the polling interval specified in the stack. The stack will continue to run a timer to poll the hardware until the physical link is disconnected or CBluetoothPhysicalLinkMetrics::Cancel is called

TransmitPowerLevelChanged(TInt8)

void

TransmitPowerLevelChanged

(

TInt8

aTransmitPowerLevel

)

Parameters

TInt8 aTransmitPowerLevel

Member Data Documentation

CBluetoothPhysicalLinkMetricSubscriber * iFailedContactCounterBaseband

CBluetoothPhysicalLinkMetricSubscriber *

iFailedContactCounterBaseband

[private]

CBluetoothPhysicalLinkMetricSubscriber * iLinkQualityBaseband

CBluetoothPhysicalLinkMetricSubscriber *

iLinkQualityBaseband

[private]

MBluetoothPhysicalLinkMetricsObserver & iObserver

MBluetoothPhysicalLinkMetricsObserver &

iObserver

[private]

CBluetoothPhysicalLinkMetricSubscriber * iRssiBaseband

CBluetoothPhysicalLinkMetricSubscriber *

iRssiBaseband

[private]

CBluetoothPhysicalLinkMetricSubscriber * iTransmitPowerLevelBaseband

CBluetoothPhysicalLinkMetricSubscriber *

iTransmitPowerLevelBaseband

[private]