CBluetoothPhysicalLinkMetrics Class Reference

#include <bt_sock.h>

class CBluetoothPhysicalLinkMetrics : public CBase

Inherits from

  • CBluetoothPhysicalLinkMetrics

    Detailed Description

    Class to subscribe to physical link metrics

    Constructor & Destructor Documentation

    ~CBluetoothPhysicalLinkMetrics ( )

    IMPORT_C~CBluetoothPhysicalLinkMetrics()

    Destructor

    Member Function Documentation

    Cancel ( )

    IMPORT_C voidCancel()

    Cancels subscriptions to all physical link notifications.

    FailedContactCounterChanged ( TUint16 )

    voidFailedContactCounterChanged(TUint16aFailedContactCounter)

    LinkQualityChanged ( TUint8 )

    voidLinkQualityChanged(TUint8aLinkQuality)

    NewL ( MBluetoothPhysicalLinkMetricsObserver &, RSocketServ &, RSocket & )

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

    Creates a new CBluetoothPhysicalLinkMetrics object from a connected socket

    ParameterDescription
    aObserverThe object which will receive asynchronous events
    aSockServA handle to an existing session on the socket server (ESock).
    aConnectedSocketAn 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

    ParameterDescription
    aObserverThe object which will receive asynchronous events
    aSockServA handle to an existing session on the socket server (ESock).
    aAddrThe Bluetooth address of a remote device with which there is an existing connection

    RssiChanged ( TInt8 )

    voidRssiChanged(TInt8aRssi)

    SubscribeError ( TInt )

    voidSubscribeError(TIntaError)

    SubscribeFailedContactCounter ( )

    IMPORT_C voidSubscribeFailedContactCounter()

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

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

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

    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 )

    voidTransmitPowerLevelChanged(TInt8aTransmitPowerLevel)