« Back to documentation index
AdvertisingReportEvent Struct Reference
Event generated when an advertising packet is seen during passive scanning or a scan response is received during active scanning.
More...
#include <Events.h >
AdvertisingReportEvent (const advertising_event_t &type, const peer_address_type_t &peerAddressType, const address_t &peerAddress, const phy_t &primaryPhy, const phy_t &secondaryPhy, advertising_sid_t SID, advertising_power_t txPower, rssi_t rssi, uint16_t periodicInterval, const peer_address_type_t &directAddressType, const address_t &directAddress, const mbed::Span < const uint8_t > &advertisingData) Create an advertising report event. const advertising_event_t & getType () const Get event type. const peer_address_type_t & getPeerAddressType () const Get peer address type. const address_t & getPeerAddress () const Get peer address. const phy_t & getPrimaryPhy () const Get primary PHY. const phy_t & getSecondaryPhy () const Get secondary PHY. advertising_sid_t getSID () const Get advertising set identifier. advertising_power_t getTxPower () const Get TX power. rssi_t getRssi () const Get received signal strength. bool isPeriodicIntervalPresent () const Indicate if periodic interval is valid. periodic_interval_t getPeriodicInterval () const Get interval. const peer_address_type_t & getDirectAddressType () const Get target address type in directed advertising. const address_t & getDirectAddress () const Get target address in directed advertising. const mbed::Span < const uint8_t > & getPayload () const Get payload.
Detailed Description
Event generated when an advertising packet is seen during passive scanning or a scan response is received during active scanning.
See also: ble::Gap::EventHandler::onPeriodicAdvertisingReport() Definition at line 38 of file Events.h .
Constructor & Destructor Documentation
AdvertisingReportEvent (
const advertising_event_t &
type ,
const peer_address_type_t &
peerAddressType ,
const address_t &
peerAddress ,
const phy_t &
primaryPhy ,
const phy_t &
secondaryPhy ,
advertising_sid_t SID ,
advertising_power_t txPower ,
rssi_t rssi ,
uint16_t
periodicInterval ,
const peer_address_type_t &
directAddressType ,
const address_t &
directAddress ,
const mbed::Span < const uint8_t > &
advertisingData
)
Create an advertising report event.
Parameters:
type Type of advertising used. peerAddressType Peer address type of advertiser. peerAddress Peer address of advertiser. primaryPhy PHY used on the primary channels. secondaryPhy PHY used on secondary channels. SID Set identification number. txPower Transmission power reported by the packet. rssi Measured signal strength. periodicInterval Interval of periodic advertising. directAddressType Directed advertising target address type. directAddress Directed advertising target address. advertisingData Advertising payload.
Definition at line 56 of file Events.h .
Member Function Documentation
Get target address in directed advertising.
Definition at line 153 of file Events.h .
Get target address type in directed advertising.
Definition at line 147 of file Events.h .
const mbed::Span <const uint8_t>& getPayload
(
)
const
Get peer address.
Definition at line 100 of file Events.h .
Get peer address type.
Definition at line 94 of file Events.h .
const phy_t & getPrimaryPhy
(
)
const
Get primary PHY.
Definition at line 106 of file Events.h .
Get received signal strength.
Definition at line 130 of file Events.h .
const phy_t & getSecondaryPhy
(
)
const
Get secondary PHY.
Definition at line 112 of file Events.h .
Get advertising set identifier.
Definition at line 118 of file Events.h .
Get event type.
Definition at line 88 of file Events.h .
bool isPeriodicIntervalPresent
(
)
const
Indicate if periodic interval is valid.
Definition at line 136 of file Events.h .
1.7.2