Mbed OS Reference
Loading...
Searching...
No Matches
PeriodicAdvertisingSyncEstablishedEvent Struct Reference

Event generated when you first receive a periodic advertisement. More...

#include <Events.h>

Public Member Functions

ble_error_t getStatus () const
 Get sync establishment status. More...
 
periodic_sync_handle_t getSyncHandle () const
 Get periodic advertising sync handle. More...
 
advertising_sid_t getSid () const
 Get advertising set identifier. More...
 
const peer_address_type_tgetPeerAddressType () const
 Get peer address type. More...
 
const address_tgetPeerAddress () const
 Get peer address. More...
 
const phy_tgetPeerPhy () const
 Get PHY used. More...
 
uint16_t getAdvertisingInterval () const
 Get interval. More...
 
const clock_accuracy_t & getPeerClockAccuracy () const
 Get clock accuracy in parts per million. More...
 

Detailed Description

Event generated when you first receive a periodic advertisement.

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

Definition at line 373 of file Events.h.

Member Function Documentation

◆ getStatus()

ble_error_t getStatus ( ) const

Get sync establishment status.

Definition at line 411 of file Events.h.

◆ getSyncHandle()

periodic_sync_handle_t getSyncHandle ( ) const

Get periodic advertising sync handle.

Definition at line 417 of file Events.h.

◆ getSid()

advertising_sid_t getSid ( ) const

Get advertising set identifier.

Definition at line 423 of file Events.h.

◆ getPeerAddressType()

const peer_address_type_t & getPeerAddressType ( ) const

Get peer address type.

Definition at line 429 of file Events.h.

◆ getPeerAddress()

const address_t & getPeerAddress ( ) const

Get peer address.

Definition at line 435 of file Events.h.

◆ getPeerPhy()

const phy_t & getPeerPhy ( ) const

Get PHY used.

Definition at line 441 of file Events.h.

◆ getAdvertisingInterval()

uint16_t getAdvertisingInterval ( ) const

Get interval.

Definition at line 447 of file Events.h.

◆ getPeerClockAccuracy()

const clock_accuracy_t & getPeerClockAccuracy ( ) const

Get clock accuracy in parts per million.

Definition at line 453 of file Events.h.