Class CBluetoothPhysicalLinkMetrics

class CBluetoothPhysicalLinkMetrics : public CBase;

Description

Class to subscribe to physical link metrics

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CBluetoothPhysicalLinkMetrics - Class to subscribe to physical link metrics

Members

Defined in CBluetoothPhysicalLinkMetrics:

• Cancel()Cancels subscriptions to all physical link notifications.
• NewL(MBluetoothPhysicalLinkMetricsObserver &,RSocketServ &,RSocket &)Creates a new CBluetoothPhysicalLinkMetrics object from a connected socket
• NewL(MBluetoothPhysicalLinkMetricsObserver &,RSocketServ &,const TBTDevAddr &)Creates a new CBluetoothPhysicalLinkMetrics object from a connected socket
• SubscribeFailedContactCounter()Subscribes for notification of changes to the Failed Contact counter of the link...
• SubscribeLinkQuality()Subscribes for notification of changes to the Link Quality. MBluetoothPhysicalLi...
• SubscribeRssi()Subscribes for notification of changes to the RSSI (Received Signal Strengh Indi...
• SubscribeTransmitPowerLevel()Subscribes for notification of changes to the Transmit Power Level of the link. ...
• ~CBluetoothPhysicalLinkMetrics()Destructor

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

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

Description

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

Return value

CBluetoothPhysicalLinkMetrics *

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

Description

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

Return value

CBluetoothPhysicalLinkMetrics *

IMPORT_C ~CBluetoothPhysicalLinkMetrics();

Description

Destructor

IMPORT_C void SubscribeRssi();

Description

Subscribes for notification of changes to the RSSI (Received Signal Strengh Indication) of the link. MBluetoothPhysicalLinkMetricsObserver::MbplmoRssiChanged(TInt8) 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

IMPORT_C void SubscribeLinkQuality();

Description

Subscribes for notification of changes to the Link Quality. MBluetoothPhysicalLinkMetricsObserver::MbplmoLinkQualityChanged(TUint8) 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

IMPORT_C void SubscribeFailedContactCounter();

Description

Subscribes for notification of changes to the Failed Contact counter of the link. MBluetoothPhysicalLinkMetricsObserver::MbplmoFailedContactCounterChanged(TUint16) 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

IMPORT_C void SubscribeTransmitPowerLevel();

Description

Subscribes for notification of changes to the Transmit Power Level of the link. MBluetoothPhysicalLinkMetricsObserver::MbplmoTransmitPowerLevelChanged(TInt8) 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

IMPORT_C void Cancel();

Description

Cancels subscriptions to all physical link notifications.