herald::ble::HeraldProtocolV1Provider Class Reference

#include <ble_protocols.h>

Inheritance diagram for herald::ble::HeraldProtocolV1Provider:

Public Member Functions
virtual bool	openConnection (const TargetIdentifier &toTarget)=0
virtual bool	closeConnection (const TargetIdentifier &toTarget)=0
virtual void	restartScanningAndAdvertising ()=0
virtual std::optional< Activity >	serviceDiscovery (Activity)=0
virtual std::optional< Activity >	readPayload (Activity)=0

Detailed Description

The Herald protocols' low level activities. Implemented by each OS' provider

Member Function Documentation

closeConnection()

virtual bool herald::ble::HeraldProtocolV1Provider::closeConnection ( const TargetIdentifier &  toTarget )

pure virtual

Closes a connection. Returns true if successful or already disconnected

Implemented in herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, BLEDatabaseT, SensorDelegateSetT >, herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, herald::ble::ConcreteBLEDatabase< ContextT, 10 >, SensorDelegateSetT >, herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, BLEDatabaseT, SensorDelegateSetT >, and herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, herald::ble::ConcreteBLEDatabase< ContextT, 10 >, SensorDelegateSetT >.

openConnection()

virtual bool herald::ble::HeraldProtocolV1Provider::openConnection ( const TargetIdentifier &  toTarget )

pure virtual

Opens a new connection. Returns true if successful or already connected. Will cause scanning and advertising to stop.

Implemented in herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, BLEDatabaseT, SensorDelegateSetT >, herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, herald::ble::ConcreteBLEDatabase< ContextT, 10 >, SensorDelegateSetT >, herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, BLEDatabaseT, SensorDelegateSetT >, and herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, herald::ble::ConcreteBLEDatabase< ContextT, 10 >, SensorDelegateSetT >.

restartScanningAndAdvertising()

virtual void herald::ble::HeraldProtocolV1Provider::restartScanningAndAdvertising ( )

pure virtual

Restart scanning and advertising (if they were previously doing so)

Implemented in herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, BLEDatabaseT, SensorDelegateSetT >, herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, herald::ble::ConcreteBLEDatabase< ContextT, 10 >, SensorDelegateSetT >, herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, BLEDatabaseT, SensorDelegateSetT >, and herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, herald::ble::ConcreteBLEDatabase< ContextT, 10 >, SensorDelegateSetT >.

---

The documentation for this class was generated from the following file:

• D:/git/skunkworks/herald-for-cpp/herald/include/herald/ble/ble_protocols.h