Mbed OS Reference
Loading...
Searching...
No Matches
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>

Public Member Functions

const advertising_event_t & getType () const
 Get event type. More...
 
const peer_address_type_tgetPeerAddressType () const
 Get peer address type. More...
 
const address_tgetPeerAddress () const
 Get peer address. More...
 
const phy_tgetPrimaryPhy () const
 Get primary PHY. More...
 
const phy_tgetSecondaryPhy () const
 Get secondary PHY. More...
 
advertising_sid_t getSID () const
 Get advertising set identifier. More...
 
advertising_power_t getTxPower () const
 Get TX power. More...
 
rssi_t getRssi () const
 Get received signal strength. More...
 
bool isPeriodicIntervalPresent () const
 Indicate if periodic interval is valid. More...
 
periodic_interval_t getPeriodicInterval () const
 Get interval. More...
 
const peer_address_type_tgetDirectAddressType () const
 Get target address type in directed advertising. More...
 
const address_tgetDirectAddress () const
 Get target address in directed advertising. More...
 
const mbed::Span< const uint8_t > & getPayload () const
 Get payload. More...
 
void setPeerAddress (const address_t &newPeerAddress)
 Set peer address. More...
 
void setPeerAddressType (const peer_address_type_t &newPeerAddressType)
 Set peer address type. More...
 
void setAdvertisingData (const mbed::Span< const uint8_t > &newAdvertisingData)
 Set new advertising payload. More...
 

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 40 of file Events.h.

Member Function Documentation

◆ getType()

const advertising_event_t & getType ( ) const

Get event type.

Definition at line 89 of file Events.h.

◆ getPeerAddressType()

const peer_address_type_t & getPeerAddressType ( ) const

Get peer address type.

Definition at line 95 of file Events.h.

◆ getPeerAddress()

const address_t & getPeerAddress ( ) const

Get peer address.

Definition at line 101 of file Events.h.

◆ getPrimaryPhy()

const phy_t & getPrimaryPhy ( ) const

Get primary PHY.

Definition at line 107 of file Events.h.

◆ getSecondaryPhy()

const phy_t & getSecondaryPhy ( ) const

Get secondary PHY.

Definition at line 113 of file Events.h.

◆ getSID()

advertising_sid_t getSID ( ) const

Get advertising set identifier.

Definition at line 119 of file Events.h.

◆ getTxPower()

advertising_power_t getTxPower ( ) const

Get TX power.

Definition at line 125 of file Events.h.

◆ getRssi()

rssi_t getRssi ( ) const

Get received signal strength.

Definition at line 131 of file Events.h.

◆ isPeriodicIntervalPresent()

bool isPeriodicIntervalPresent ( ) const

Indicate if periodic interval is valid.

Definition at line 137 of file Events.h.

◆ getPeriodicInterval()

periodic_interval_t getPeriodicInterval ( ) const

Get interval.

Definition at line 142 of file Events.h.

◆ getDirectAddressType()

const peer_address_type_t & getDirectAddressType ( ) const

Get target address type in directed advertising.

Definition at line 148 of file Events.h.

◆ getDirectAddress()

const address_t & getDirectAddress ( ) const

Get target address in directed advertising.

Definition at line 154 of file Events.h.

◆ getPayload()

const mbed::Span< const uint8_t > & getPayload ( ) const

Get payload.

Definition at line 160 of file Events.h.

◆ setPeerAddress()

void setPeerAddress ( const address_t newPeerAddress)

Set peer address.

Definition at line 166 of file Events.h.

◆ setPeerAddressType()

void setPeerAddressType ( const peer_address_type_t newPeerAddressType)

Set peer address type.

Definition at line 175 of file Events.h.

◆ setAdvertisingData()

void setAdvertisingData ( const mbed::Span< const uint8_t > &  newAdvertisingData)

Set new advertising payload.

Definition at line 183 of file Events.h.