Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions | Protected Member Functions
LinkLossService Class Reference

This service defines behavior when a link is lost between two devices. More...

#include <LinkLossService.h>

Inheritance diagram for LinkLossService:
Gap::EventHandler

Public Member Functions

 LinkLossService (BLE &bleIn, callback_t callbackIn, AlertLevel_t levelIn=NO_ALERT)
 
void setCallback (callback_t newCallback)
 Update the callback. More...
 
void setAlertLevel (AlertLevel_t newLevel)
 Update alertness level. More...
 
virtual void onScanRequestReceived (const ScanRequestEvent &event)
 Called when an advertising device receive a scan response. More...
 
virtual void onAdvertisingEnd (const AdvertisingEndEvent &event)
 Called when advertising ends. More...
 
virtual void onAdvertisingReport (const AdvertisingReportEvent &event)
 Called when a scanner receives an advertising or a scan response packet. More...
 
virtual void onScanTimeout (const ScanTimeoutEvent &event)
 Called when scan times out. More...
 
virtual void onPeriodicAdvertisingSyncEstablished (const PeriodicAdvertisingSyncEstablishedEvent &event)
 Called when first advertising packet in periodic advertising is received. More...
 
virtual void onPeriodicAdvertisingReport (const PeriodicAdvertisingReportEvent &event)
 Called when a periodic advertising packet is received. More...
 
virtual void onPeriodicAdvertisingSyncLoss (const PeriodicAdvertisingSyncLoss &event)
 Called when a periodic advertising sync has been lost. More...
 
virtual void onConnectionComplete (const ConnectionCompleteEvent &event)
 Called when connection attempt ends or an advertising device has been connected. More...
 
virtual void onUpdateConnectionParametersRequest (const UpdateConnectionParametersRequestEvent &event)
 Called when the peer request connection parameters updates. More...
 
virtual void onConnectionParametersUpdateComplete (const ConnectionParametersUpdateCompleteEvent &event)
 Called when connection parameters have been updated. More...
 
virtual void onReadPhy (ble_error_t status, connection_handle_t connectionHandle, phy_t txPhy, phy_t rxPhy)
 Function invoked when the current transmitter and receiver PHY have been read for a given connection. More...
 
virtual void onPhyUpdateComplete (ble_error_t status, connection_handle_t connectionHandle, phy_t txPhy, phy_t rxPhy)
 Function invoked when the update process of the PHY has been completed. More...
 
virtual void onDataLengthChange (connection_handle_t connectionHandle, uint16_t txSize, uint16_t rxSize)
 Function invoked when the connections changes the maximum number of octets that can be sent or received by the controller in a single packet. More...
 

Protected Member Functions

virtual void onDataWritten (const GattWriteCallbackParams *params)
 This callback allows receiving updates to the AlertLevel characteristic. More...
 
virtual void onDisconnectionComplete (const ble::DisconnectionCompleteEvent &)
 Called when a connection has been disconnected. More...
 

Detailed Description

This service defines behavior when a link is lost between two devices.

Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.link_loss.xml Alertness Level Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.alert_level.xml

Definition at line 34 of file LinkLossService.h.

Constructor & Destructor Documentation

LinkLossService ( BLE bleIn,
callback_t  callbackIn,
AlertLevel_t  levelIn = NO_ALERT 
)
Parameters
bleInBLE object for the underlying controller.
callbackInCallback invoked upon disconnection.
levelInAlert level.

Definition at line 51 of file LinkLossService.h.

Member Function Documentation

virtual void onAdvertisingEnd ( const AdvertisingEndEvent event)
virtualinherited

Called when advertising ends.

Advertising ends when the process timeout or if it is stopped by the application or if the local device accepts a connection request.

Parameters
eventAdvertising end event.
See also
startAdvertising()
stopAdvertising()
onConnectionComplete()

Definition at line 333 of file Gap.h.

virtual void onAdvertisingReport ( const AdvertisingReportEvent event)
virtualinherited

Called when a scanner receives an advertising or a scan response packet.

Parameters
eventAdvertising report.
See also
startScan()

Definition at line 344 of file Gap.h.

virtual void onConnectionComplete ( const ConnectionCompleteEvent event)
virtualinherited

Called when connection attempt ends or an advertising device has been connected.

See also
startAdvertising()
connect()
Parameters
eventConnection event.

Definition at line 413 of file Gap.h.

virtual void onConnectionParametersUpdateComplete ( const ConnectionParametersUpdateCompleteEvent event)
virtualinherited

Called when connection parameters have been updated.

Parameters
eventThe new connection parameters.
See also
updateConnectionParameters()
acceptConnectionParametersUpdate()

Definition at line 448 of file Gap.h.

virtual void onDataLengthChange ( connection_handle_t  connectionHandle,
uint16_t  txSize,
uint16_t  rxSize 
)
virtualinherited

Function invoked when the connections changes the maximum number of octets that can be sent or received by the controller in a single packet.

A single L2CAP packet can be fragmented across many such packets.

Note
This only triggers if controller supports data length extension and negotiated data length is longer than the default 23.
Parameters
connectionHandleThe handle of the connection that changed the size.
txSizeNumber of octets we can send on this connection in a single packet.
rxSizeNumber of octets we can receive on this connection in a single packet.

Definition at line 538 of file Gap.h.

virtual void onDataWritten ( const GattWriteCallbackParams params)
protectedvirtual

This callback allows receiving updates to the AlertLevel characteristic.

Parameters
[in]paramsInformation about the characteristic being updated.

Definition at line 92 of file LinkLossService.h.

virtual void onDisconnectionComplete ( const ble::DisconnectionCompleteEvent event)
protectedvirtual

Called when a connection has been disconnected.

Parameters
eventDetails of the event.
See also
disconnect()

Reimplemented from Gap::EventHandler.

Definition at line 98 of file LinkLossService.h.

virtual void onPeriodicAdvertisingReport ( const PeriodicAdvertisingReportEvent event)
virtualinherited

Called when a periodic advertising packet is received.

Parameters
eventPeriodic advertisement event.
Version
: 5+.
See also
createSync()

Definition at line 383 of file Gap.h.

virtual void onPeriodicAdvertisingSyncEstablished ( const PeriodicAdvertisingSyncEstablishedEvent event)
virtualinherited

Called when first advertising packet in periodic advertising is received.

Parameters
eventPeriodic advertising sync event.
Version
: 5+.
See also
createSync()

Definition at line 368 of file Gap.h.

virtual void onPeriodicAdvertisingSyncLoss ( const PeriodicAdvertisingSyncLoss event)
virtualinherited

Called when a periodic advertising sync has been lost.

Parameters
eventDetails of the event.
Version
: 5+.
See also
createSync()

Definition at line 398 of file Gap.h.

virtual void onPhyUpdateComplete ( ble_error_t  status,
connection_handle_t  connectionHandle,
phy_t  txPhy,
phy_t  rxPhy 
)
virtualinherited

Function invoked when the update process of the PHY has been completed.

The process can be initiated by a call to the function setPhy, the local bluetooth subsystem or the peer.

Parameters
statusStatus of the operation: BLE_ERROR_NONE in case of success or an appropriate error code.
connectionHandleThe handle of the connection on which the operation was made.
txPhyPHY used by the transmitter.
rxPhyPHY used by the receiver.
Note
Success doesn't mean the PHY has been updated it means both ends have negotiated the best PHY according to their configuration and capabilities. The PHY currently used are present in the txPhy and rxPhy parameters.
See also
setPhy()
Version
: 5+.

Definition at line 517 of file Gap.h.

virtual void onReadPhy ( ble_error_t  status,
connection_handle_t  connectionHandle,
phy_t  txPhy,
phy_t  rxPhy 
)
virtualinherited

Function invoked when the current transmitter and receiver PHY have been read for a given connection.

Parameters
statusStatus of the operation: BLE_ERROR_NONE in case of success or an appropriate error code.
connectionHandleThe handle of the connection for which the PHYs have been read.
txPhyPHY used by the transmitter.
rxPhyPHY used by the receiver.
See also
readPhy().
Version
: 5+.

Definition at line 483 of file Gap.h.

virtual void onScanRequestReceived ( const ScanRequestEvent event)
virtualinherited

Called when an advertising device receive a scan response.

Parameters
eventScan request event.
Version
: 5+.
See also
AdvertisingParameters::setScanRequestNotification().

Definition at line 317 of file Gap.h.

virtual void onScanTimeout ( const ScanTimeoutEvent event)
virtualinherited

Called when scan times out.

Parameters
eventAssociated event.
See also
startScan()

Definition at line 355 of file Gap.h.

virtual void onUpdateConnectionParametersRequest ( const UpdateConnectionParametersRequestEvent event)
virtualinherited

Called when the peer request connection parameters updates.

Application must accept the update with acceptConnectionParametersUpdate() or reject it with rejectConnectionParametersUpdate().

Parameters
eventThe connection parameters requested by the peer.
Version
4.1+.
Note
This event is not generated if connection parameters update is managed by the middleware.
See also
manageConnectionParametersUpdateRequest()
acceptConnectionParametersUpdate()
rejectConnectionParametersUpdate()

Definition at line 434 of file Gap.h.

void setAlertLevel ( AlertLevel_t  newLevel)

Update alertness level.

Definition at line 81 of file LinkLossService.h.

void setCallback ( callback_t  newCallback)

Update the callback.

Definition at line 74 of file LinkLossService.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.