CwclBluetoothLeBeaconWatcher Class Reference

The Bluetooth LE Beacon watcher. More...

#include <wclBluetooth.h>

Inheritance diagram for CwclBluetoothLeBeaconWatcher:

Public Member Functions
	CwclBluetoothLeBeaconWatcher ()
	Creates new component.
virtual	~CwclBluetoothLeBeaconWatcher ()
	Frees the component.
int	Start (CwclBluetoothRadio *const Radio)
	Starts monitoring for Bluetooth LE Beacons.
int	Stop ()
	Stops monitoring for Bluetooth LE Beacons.
int	RestoreDefaults ()
	Restores the default scan parameters.
bool	GetMonitoring () const
	Gets Beacon Monitoring state.
	__declspec (property(get=GetMonitoring)) bool Monitoring
	Gets Beacon Monitoring state.
CwclBluetoothRadio *	GetRadio () const
	Gets the watcher owner.
	__declspec (property(get=GetRadio)) CwclBluetoothRadio *Radio
	Gets the watcher owner.
bool	GetAllowExtendedAdvertisements () const
	Gets the Extended Advertisement receiving flag.
void	SetAllowExtendedAdvertisements (const bool Value)
	Sets the Extended Advertisement receiving flag.
	__declspec (property(get=GetAllowExtendedAdvertisements, put=SetAllowExtendedAdvertisements)) bool AllowExtendedAdvertisements
	Gets and sets the Extended Advertisement receiving flag.
wclBluetoothLeScanningMode	GetScanningMode () const
	Gets the current scanning mode.
void	SetScanningMode (const wclBluetoothLeScanningMode Value)
	Sets the current scanning mode.
	__declspec (property(get=GetScanningMode, put=SetScanningMode)) wclBluetoothLeScanningMode ScanningMode
	Gets and sets the current scanning mode.
wclBluetoothLeScanParametersType	GetScanParametersType () const
	Gets a Bluetooth LE scan parameters type.
void	SetScanParametersType (const wclBluetoothLeScanParametersType Value)
	Sets a Bluetooth LE scan parameters type.
	__declspec (property(get=GetScanParametersType, put=SetScanParametersType)) wclBluetoothLeScanParametersType ScanParametersType
	Gets and sets a Bluetooth LE scan parameters type.
unsigned short	GetScanInterval () const
	Gets the current scan interval value.
void	SetScanInterval (unsigned short Value)
	Sets scan interval value.
	__declspec (property(get=GetScanInterval, put=SetScanInterval)) unsigned short ScanInterval
	Gets and sets the current scan interval value.
unsigned short	GetScanWindow () const
	Gets the current scan window value.
void	SetScanWindow (const unsigned short Value)
	Sets the current scan window value.
	__declspec (property(get=GetScanWindow, put=SetScanWindow)) unsigned short ScanWindow
	Gets and sets the current scan window value.
__event void	OnAdvertisementAppearanceFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Appearance)
	The event fires when an appearance advertisement frame received.
__event void	OnAdvertisementFrameInformation (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const tstring &Name, const wclBluetoothLeAdvertisementType PacketType, const wclBluetoothLeAdvertisementFlags &Flags)
	The event fires when new Bluetooth LE advertisement frame has been received and provides the common basic information about the frame.
__event void	OnAdvertisementExtFrameInformation (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const wclBluetoothAddressType AddressType, const char TxPower, const wclBluetoothLeExtendedFrameFlags &Flags, const wclBluetoothLeAdvertisementPhy PrimaryPhy, const wclBluetoothLeAdvertisementPhy SecondaryPhy)
	The event fires when new Bluetooth LE advertisement extended frame has been received and provides the common basic information about the frame.
__event void	OnAdvertisementRawFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned char DataType, const wclBluetoothLeAdvertisementFrameRawData &Data)
	The OnAdvertisementRawFrame event handler prototype.
__event void	OnAdvertisementReceived (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const wclBluetoothLeAdvertisementFrameRawData &Data)
	The event fires when any Bluetooth LE advertisement frame received.
__event void	OnAdvertisementService16DataFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data)
	The event fires when a Bluetooth LE 16 bit Service Data advertisement frame received.
__event void	OnAdvertisementService32DataFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data)
	The event fires when a Bluetooth LE 32 bit Service Data advertisement frame received.
__event void	OnAdvertisementService128DataFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data)
	The event fires when a Bluetooth LE 128 bit Service Data advertisement frame received.
__event void	OnAdvertisementServiceSol16Frame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Uuid)
	The event fires when a Bluetooth LE 16 bit Service Solicitation advertisement frame received.
__event void	OnAdvertisementServiceSol32Frame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long Uuid)
	The event fires when a Bluetooth LE 32 bit Service Solicitation advertisement frame received.
__event void	OnAdvertisementServiceSol128Frame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid)
	The event fires when a Bluetooth LE 128 bit Service Solicitation advertisement frame received.
__event void	OnAdvertisementTxPowerLevelFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxPower)
	The event fires when a TX power level advertisement frame received.
__event void	OnAdvertisementUuidFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid)
	The event fires when an UUID advertisement frame has been received.
__event void	OnAltBeaconFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short CompanyId, const unsigned short Major, const unsigned short Minor, const GUID &Uuid, const char TxRssi, const unsigned char Reserved, const wclBluetoothLeAdvertisementFrameRawData &Data)
	The event fires when a Bluetooth LE Alt beacon advertisement frame received.
__event void	OnAppleAirdropFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleAirdropFrameData &Data)
	The event fires when an Apple Airdrop advertisement frame received.
__event void	OnAppleAirplaySourceFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleAirplaySourceFrameData &Data)
	The event fires when an Apple Airplay Source advertisement frame received.
__event void	OnAppleAirplayTargetFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleAirplayTargetFrameData &Data)
	The event fires when an Apple Airplay Target advertisement frame received.
__event void	OnAppleAirprintFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleAirprintFrameData &Data)
	The event fires when an Apple Airprint advertisement frame received.
__event void	OnAppleFindMyFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleFindMyFrameData &Data)
	The event fires when an Apple Find My advertisement frame received.
__event void	OnAppleHandoffFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleHandoffFrameData &Data)
	The event fires when an Apple Handoff advertisement frame received.
__event void	OnAppleHeySiriFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleHeySiriFrameData &Data)
	The event fires when an Apple Hey Siri advertisement frame received.
__event void	OnAppleHomeKitFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleHomeKitFrameData &Data)
	The event fires when an Apple HomeKit advertisement frame received.
__event void	OnAppleiBeaconFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleiBeaconFrameData &Data)
	The event fires when an Apple iBeacon advertisement frame received.
__event void	OnAppleMagicSwitchFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleMagicSwitchFrameData &Data)
	The event fires when an Apple Magic Switch advertisement frame received.
__event void	OnAppleNearbyActionFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleNearbyActionFrameData &Data)
	The event fires when an Apple Nearby Action advertisement frame received.
__event void	OnAppleNearbyInfoFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleNearbyInfoFrameData &Data)
	The event fires when an Apple Nearby Info advertisement frame received.
__event void	OnAppleProximityPairingFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleProximityPairingFrameData &Data)
	The event fires when an Apple Proximity Pairing advertisement frame received.
__event void	OnAppleTetheringSourceFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleTetheringSourceFrameData &Data)
	The event fires when an Tethering Source advertisement frame received.
__event void	OnAppleTetheringTargetFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleTetheringTargetFrameData &Data)
	The event fires when an Tethering Target advertisement frame received.
__event void	OnAppleUnknownFrame (void *Sender, const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleUnknownFrameData &Data)
	The event fires when an unknown Apple advertisement frame received.
__event void	OnDriAsdMessage (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const wclDriRawData &Raw)
	The event fires when a Drone Remote ID ASD message received.
__event void	OnEddystoneTlmFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long AdvCnt, const unsigned short Batt, const unsigned long SecCnt, const double Temp, const wclBluetoothLeAdvertisementFrameRawData &Data)
	The OnEddystoneTlmFrame event handler prototype.
__event void	OnEddystoneUidFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxRssi, const GUID &Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data)
	The OnEddystoneUidFrame event handler prototype.
__event void	OnEddystoneUrlFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxRssi, const tstring &Url)
	The OnEddystoneUrlFrame event handler prototype.
__event void	OnManufacturerRawFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short CompanyId, const wclBluetoothLeAdvertisementFrameRawData &Data)
	The OnManufacturerRawFrame event handler prototype.
__event void	OnMicrosoftCdpBeaconFrame (void *Sender, const __int64 Address, const __int64 Timestamp, const char Rssi, const wclBluetoothLeCdpBeaconScenarioType ScenarioType, const unsigned char Version, const wclBluetoothLeCdpBeaconDeviceType DeviceType, const unsigned char SubVersion, const bool ShareNearBy, const bool AddressAsDeviceId, const wclBluetoothLeCdpBeaconExtendedDeviceStatuses &ExtendedDeviceStatus, const wclBluetoothLeCdpBeaconSalt &Salt, const wclBluetoothLeCdpBeaconHash &Hash)
	The event fires when Microsoft CDP Beacon frame received.
__event void	OnStarted (void *Sender)
	The event fires when the Bluetooth LE beacon monitoring started.
__event void	OnStopped (void *Sender)
	The event fires when the Bluetooth LE beacon monitoring stopped.
Public Member Functions inherited from CwclBluetoothComponent
	CwclBluetoothComponent ()
	Creates a new component.
virtual	~CwclBluetoothComponent ()
	Frees the component.

Protected Member Functions
virtual void	DoAdvertisementAppearanceFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Appearance)
	Fires the OnAdvertisementAppearanceFrame event.
virtual void	DoAdvertisementFrameInformation (const __int64 Address, const __int64 Timestamp, const char Rssi, const tstring &Name, const wclBluetoothLeAdvertisementType PacketType, const wclBluetoothLeAdvertisementFlags &Flags)
	Fires the OnAdvertisementFrameInformation event.
virtual void	DoAdvertisementExtFrameInformation (const __int64 Address, const __int64 Timestamp, const char Rssi, const wclBluetoothAddressType AddressType, const char TxPower, const wclBluetoothLeExtendedFrameFlags &Flags, const wclBluetoothLeAdvertisementPhy PrimaryPhy, const wclBluetoothLeAdvertisementPhy SecondaryPhy)
	Fires the OnAdvertisementExtFrameInformation event.
virtual void	DoAdvertisementRawFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned char DataType, const wclBluetoothLeAdvertisementFrameRawData &Data)
	Fires the OnAdvertisementRawFrame event.
virtual void	DoAdvertisementReceived (const __int64 Address, const __int64 Timestamp, const char Rssi, const wclBluetoothLeAdvertisementFrameRawData &Data)
	Fires the OnAdvertisementReceived event.
virtual void	DoAdvertisementService16DataFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data)
	Fires the OnService16DataFrame event.
virtual void	DoAdvertisementService32DataFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data)
	Fires the OnService32DataFrame event.
virtual void	DoAdvertisementService128DataFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data)
	Fires the OnService128DataFrame event.
virtual void	DoAdvertisementServiceSol16Frame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short Uuid)
	Fires the OnServiceSol16Frame event.
virtual void	DoAdvertisementServiceSol32Frame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long Uuid)
	Fires the OnServiceSol32Frame event.
virtual void	DoAdvertisementServiceSol128Frame (const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid)
	Fires the OnServiceSol128Frame event.
virtual void	DoAdvertisementTxPowerLevelFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxPower)
	Fires the OnAdvertisementTxPowerLevelFrame event.
virtual void	DoAdvertisementUuidFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const GUID &Uuid)
	Fires the OnAdvertisementUuidFrame event.
virtual void	DoAltBeaconFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short CompanyId, const unsigned short Major, const unsigned short Minor, const GUID &Uuid, const char TxRssi, const unsigned char Reserved, const wclBluetoothLeAdvertisementFrameRawData &Data)
	Fires the OnAltBeaconFrame event.
virtual void	DoAppleAirdropFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleAirdropFrameData &Data)
	Fires the OnAppleAirdropFrame event.
virtual void	DoAppleAirplaySourceFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleAirplaySourceFrameData &Data)
	Fires the OnAppleAirplaySourceFrame event.
virtual void	DoAppleAirplayTargetFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleAirplayTargetFrameData &Data)
	Fires the OnAppleAirplayTargetFrame event.
virtual void	DoAppleAirprintFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleAirprintFrameData &Data)
	Fires the OnAppleAirprintFrame event.
virtual void	DoAppleFindMyFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleFindMyFrameData &Data)
	Fires the OnAppleFindMyFrame event.
virtual void	DoAppleHandoffFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleHandoffFrameData &Data)
	Fires the OnAppleHandoffFrame event.
virtual void	DoAppleHeySiriFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleHeySiriFrameData &Data)
	Fires the OnAppleHeySiriFrame event.
virtual void	DoAppleHomeKitFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleHomeKitFrameData &Data)
	Fires the OnAppleHomeKitFrame event.
virtual void	DoAppleiBeaconFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleiBeaconFrameData &Data)
	Fires the OnAppleiBeaconFrame event.
virtual void	DoAppleMagicSwitchFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleMagicSwitchFrameData &Data)
	Fires the OnAppleMagicSwitchFrame event.
virtual void	DoAppleNearbyActionFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleNearbyActionFrameData &Data)
	Fires the OnAppleNearbyActionFrame event.
virtual void	DoAppleNearbyInfoFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleNearbyInfoFrameData &Data)
	Fires the OnAppleNearbyInfoFrame event.
virtual void	DoAppleProximityPairingFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleProximityPairingFrameData &Data)
	Fires the OnAppleProximityPairingFrame event.
virtual void	DoAppleTetheringSourceFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleTetheringSourceFrameData &Data)
	Fires the OnAppleTetheringSourceFrame event.
virtual void	DoAppleTetheringTargetFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleTetheringTargetFrameData &Data)
	Fires the OnAppleTetheringTargetFrame event.
virtual void	DoAppleUnknownFrame (const wclBluetoothLeAdvertisementInfo &Info, const wclBluetoothLeAppleUnknownFrameData &Data)
	Fires the OnAppleUnknownFrame event.
virtual void	DoDriAsdMessage (const __int64 Address, const __int64 Timestamp, const char Rssi, const wclDriRawData &Raw)
	Fires the OnDriAsdMessage event.
virtual void	DoEddystoneTlmFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned long AdvCnt, const unsigned short Batt, const unsigned long SecCnt, const double Temp, const wclBluetoothLeAdvertisementFrameRawData &Data)
	Fires the OnEddystoneTlmFrame event.
virtual void	DoEddystoneUidFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxRssi, const GUID &Uuid, const wclBluetoothLeAdvertisementFrameRawData &Data)
	Fires the OnEddystoneUidFrame event.
virtual void	DoEddystoneUrlFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const char TxRssi, const tstring &Url)
	Fires the OnEddystoneUrlFrame event.
virtual void	DoManufacturerRawFrame (const __int64 Address, const __int64 Timestamp, const char Rssi, const unsigned short CompanyId, const wclBluetoothLeAdvertisementFrameRawData &Data)
	Fires the OnManufacturerRawFrame event.
virtual void	DoMicrosoftCdpBeaconFrame (__int64 Address, __int64 Timestamp, const char Rssi, const wclBluetoothLeCdpBeaconScenarioType ScenarioType, const unsigned char Version, const wclBluetoothLeCdpBeaconDeviceType DeviceType, const unsigned char SubVersion, const bool ShareNearBy, const bool AddressAsDeviceId, const wclBluetoothLeCdpBeaconExtendedDeviceStatuses &ExtendedDeviceStatus, const wclBluetoothLeCdpBeaconSalt &Salt, const wclBluetoothLeCdpBeaconHash &Hash)
	Fires the OnMicrosoftCdpBeaconFrame event.
virtual void	DoStarted ()
	Fires the OnStarted event.
virtual void	DoStopped ()
	Fires the OnStopped event.
Protected Member Functions inherited from CwclBluetoothComponent
void	SetCopy (CwclCustomConnection *const NewConnection)
	The method sets new copy of the current connection.
CwclCriticalSection *	GetCS () const
	Gets the critical section object.
	__declspec (property(get=GetCS)) CwclCriticalSection *CS
	Gets the critical section object.

Detailed Description

The Bluetooth LE Beacon watcher.

The component allows to monitor Bluetooth LE Beacon advertisement packets.

See also

CwclBluetoothComponent