Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

PeriodicAdvertisingReportEvent Struct Reference

PeriodicAdvertisingReportEvent Struct Reference
[Gap]

Event generated when periodic advertising packet is received. More...

#include <Events.h>

Public Member Functions

 PeriodicAdvertisingReportEvent (periodic_sync_handle_t syncHandle, advertising_power_t txPower, rssi_t rssi, advertising_data_status_t dataStatus, const mbed::Span< const uint8_t > &payload)
 Create periodic advertising report event.
periodic_sync_handle_t getSyncHandle () const
 Get periodic advertising sync handle.
advertising_power_t getTxPower () const
 Get TX power as reported by the advertising packet.
rssi_t getRssi () const
 Get received signal strength.
const advertising_data_status_tgetDataStatus () const
 Get data completeness status.
const mbed::Span< const uint8_t > & getPayload () const
 Get payload.

Detailed Description

Event generated when periodic advertising packet is received.

See also:
ble::Gap::EventHandler::onPeriodicAdvertisingReport().

Definition at line 416 of file Events.h.


Constructor & Destructor Documentation

PeriodicAdvertisingReportEvent ( periodic_sync_handle_t  syncHandle,
advertising_power_t  txPower,
rssi_t  rssi,
advertising_data_status_t  dataStatus,
const mbed::Span< const uint8_t > &  payload 
)

Create periodic advertising report event.

Parameters:
syncHandlePeriodic advertising sync handle
txPowerTX power.
rssiReceived signal strength.
dataStatusStatus to indicate the completeness of the payload.
payloadPeriodic advertisement payload.

Definition at line 427 of file Events.h.


Member Function Documentation

const advertising_data_status_t& getDataStatus (  ) const

Get data completeness status.

Definition at line 463 of file Events.h.

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

Get payload.

Definition at line 469 of file Events.h.

rssi_t getRssi (  ) const

Get received signal strength.

Definition at line 457 of file Events.h.

periodic_sync_handle_t getSyncHandle (  ) const

Get periodic advertising sync handle.

Definition at line 445 of file Events.h.

advertising_power_t getTxPower (  ) const

Get TX power as reported by the advertising packet.

Definition at line 451 of file Events.h.