Definition of the general handler of Gap related events. More...

#include <Gap.h>

Inheritance diagram for Gap::EventHandler:

Public Member Functions
virtual void	onScanRequestReceived (const ScanRequestEvent &event)
	Called when an advertising device receive a scan request. More...

virtual void	onAdvertisingStart (const AdvertisingStartEvent &event)
	Called when advertising starts. 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. 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	onDisconnectionComplete (const DisconnectionCompleteEvent &event)
	Called when a connection has been disconnected. 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...

virtual void	onPrivacyEnabled ()
	Function invoked when the privacy subsystem has been enabled and is ready to be used. More...

Protected Member Functions
	~EventHandler ()=default
	Prevent polymorphic deletion and avoid unnecessary virtual destructor as the Gap class will never delete the instance it contains. More...

Detailed Description

Definition of the general handler of Gap related events.

Definition at line 303 of file Gap.h.

Constructor & Destructor Documentation

◆ ~EventHandler()

~EventHandler ( )

protecteddefault

Prevent polymorphic deletion and avoid unnecessary virtual destructor as the Gap class will never delete the instance it contains.

Member Function Documentation

◆ onScanRequestReceived()

virtual void onScanRequestReceived ( const ScanRequestEvent & event )

virtual

Called when an advertising device receive a scan request.

Parameters

event Scan request event.

Version: : 5+.

See also: AdvertisingParameters::setScanRequestNotification().

Reimplemented in ChainableGapEventHandler.

Definition at line 313 of file Gap.h.

◆ onAdvertisingStart()

virtual void onAdvertisingStart ( const AdvertisingStartEvent & event )

virtual

Called when advertising starts.

Parameters

event Advertising start event.

Note: Check event.getStatus() to see if advertising started successfully

See also: startAdvertising()

Reimplemented in ChainableGapEventHandler.

Definition at line 326 of file Gap.h.

◆ onAdvertisingEnd()

virtual void onAdvertisingEnd ( const AdvertisingEndEvent & event )

virtual

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

event Advertising end event.

Note: Check event.getStatus() to see if advertising ended successfully

See also: stopAdvertising(); onConnectionComplete()

Reimplemented in ChainableGapEventHandler.

Definition at line 343 of file Gap.h.

◆ onAdvertisingReport()

virtual void onAdvertisingReport ( const AdvertisingReportEvent & event )

virtual

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

Parameters

event Advertising report.

See also: startScan()

Reimplemented in ChainableGapEventHandler.

Definition at line 354 of file Gap.h.

◆ onScanTimeout()

virtual void onScanTimeout ( const ScanTimeoutEvent & event )

virtual

Called when scan times out.

Parameters

event Associated event.

See also: startScan()

Reimplemented in ChainableGapEventHandler.

Definition at line 365 of file Gap.h.

◆ onPeriodicAdvertisingSyncEstablished()

virtual void onPeriodicAdvertisingSyncEstablished ( const PeriodicAdvertisingSyncEstablishedEvent & event )

virtual

Called when first advertising packet in periodic advertising is received.

Parameters

event Periodic advertising sync event.

Version: : 5+.

See also: createSync()

Reimplemented in ChainableGapEventHandler.

Definition at line 378 of file Gap.h.

◆ onPeriodicAdvertisingReport()

virtual void onPeriodicAdvertisingReport ( const PeriodicAdvertisingReportEvent & event )

virtual

Called when a periodic advertising packet is received.

Parameters

event Periodic advertisement event.

Version: : 5+.

See also: createSync()

Reimplemented in ChainableGapEventHandler.

Definition at line 393 of file Gap.h.

◆ onPeriodicAdvertisingSyncLoss()

virtual void onPeriodicAdvertisingSyncLoss ( const PeriodicAdvertisingSyncLoss & event )

virtual

Called when a periodic advertising sync has been lost.

Parameters

event Details of the event.

Version: : 5+.

See also: createSync()

Reimplemented in ChainableGapEventHandler.

Definition at line 408 of file Gap.h.

◆ onConnectionComplete()

virtual void onConnectionComplete ( const ConnectionCompleteEvent & event )

virtual

Called when connection attempt ends.

Check event.getStatus() to see if connection was established. If this device is the peripheral and it was advertising this will end the advertising set which will also create the onAdvertisingEnd event.

See also: startAdvertising(); connect()

Parameters

event Connection event.

Reimplemented in ChainableGapEventHandler.

Definition at line 424 of file Gap.h.

◆ onUpdateConnectionParametersRequest()

virtual void onUpdateConnectionParametersRequest ( const UpdateConnectionParametersRequestEvent & event )

virtual

Called when the peer request connection parameters updates.

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

Parameters

event The connection parameters requested by the peer.

Version: 4.1+.

Note: This event will only be produced if manageConnectionParametersUpdateRequest() was called with true. Otherwise the stack will handle the request and no event will be generated.

See also: manageConnectionParametersUpdateRequest(); acceptConnectionParametersUpdate(); rejectConnectionParametersUpdate()

Reimplemented in ChainableGapEventHandler.

Definition at line 445 of file Gap.h.

◆ onConnectionParametersUpdateComplete()

virtual void onConnectionParametersUpdateComplete ( const ConnectionParametersUpdateCompleteEvent & event )

virtual

Called when connection parameters have been updated.

Parameters

event The new connection parameters.

See also: updateConnectionParameters(); acceptConnectionParametersUpdate()

Reimplemented in ChainableGapEventHandler.

Definition at line 459 of file Gap.h.

◆ onDisconnectionComplete()

virtual void onDisconnectionComplete ( const DisconnectionCompleteEvent & event )

virtual

Called when a connection has been disconnected.

Parameters

event Details of the event.

See also: disconnect()

Reimplemented in LinkLossService, and ChainableGapEventHandler.

Definition at line 472 of file Gap.h.

◆ onReadPhy()

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

virtual

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

Parameters

status	Status of the operation: BLE_ERROR_NONE in case of success or an appropriate error code.
connectionHandle	The handle of the connection for which the PHYs have been read.
txPhy	PHY used by the transmitter.
rxPhy	PHY used by the receiver.

See also: readPhy().

Version: : 5+.

Reimplemented in ChainableGapEventHandler.

Definition at line 494 of file Gap.h.

◆ onPhyUpdateComplete()

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

virtual

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

status	Status of the operation: BLE_ERROR_NONE in case of success or an appropriate error code.
connectionHandle	The handle of the connection on which the operation was made.
txPhy	PHY used by the transmitter.
rxPhy	PHY 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+.

Reimplemented in ChainableGapEventHandler.

Definition at line 528 of file Gap.h.

◆ onDataLengthChange()

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

virtual

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

connectionHandle	The handle of the connection that changed the size.
txSize	Number of octets we can send on this connection in a single packet.
rxSize	Number of octets we can receive on this connection in a single packet.

Reimplemented in ChainableGapEventHandler.

Definition at line 549 of file Gap.h.

◆ onPrivacyEnabled()

virtual void onPrivacyEnabled ( )

virtual

Function invoked when the privacy subsystem has been enabled and is ready to be used.

See also: enablePrivacy()

Reimplemented in ChainableGapEventHandler.

Definition at line 563 of file Gap.h.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~EventHandler()

Member Function Documentation

◆ onScanRequestReceived()

◆ onAdvertisingStart()

◆ onAdvertisingEnd()

◆ onAdvertisingReport()

◆ onScanTimeout()

◆ onPeriodicAdvertisingSyncEstablished()

◆ onPeriodicAdvertisingReport()

◆ onPeriodicAdvertisingSyncLoss()

◆ onConnectionComplete()

◆ onUpdateConnectionParametersRequest()

◆ onConnectionParametersUpdateComplete()

◆ onDisconnectionComplete()

◆ onReadPhy()

◆ onPhyUpdateComplete()

◆ onDataLengthChange()

◆ onPrivacyEnabled()