Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
PeriodicAdvertisingSyncEstablishedEvent Struct Reference
[Gap]
Event generated when you first receive a periodic advertisement. More...
#include <Events.h>
Public Member Functions | |
| PeriodicAdvertisingSyncEstablishedEvent (ble_error_t status, periodic_sync_handle_t syncHandle, advertising_sid_t sid, const peer_address_type_t &peerAddressType, const address_t &peerAddress, const phy_t &peerPhy, uint16_t advertisingInterval, const clock_accuracy_t &peerClockAccuracy) | |
| Create advertising sync event. | |
| ble_error_t | getStatus () const |
| Get sync establishment status. | |
| periodic_sync_handle_t | getSyncHandle () const |
| Get periodic advertising sync handle. | |
| advertising_sid_t | getSid () const |
| Get advertising set identifier. | |
| const peer_address_type_t & | getPeerAddressType () const |
| Get peer address type. | |
| const address_t & | getPeerAddress () const |
| Get peer address. | |
| const phy_t & | getPeerPhy () const |
| Get PHY used. | |
| uint16_t | getAdvertisingInterval () const |
| Get interval. | |
| const clock_accuracy_t & | getPeerClockAccuracy () const |
| Get clock accuracy in parts per million. | |
Detailed Description
Event generated when you first receive a periodic advertisement.
- See also:
- ble::Gap::EventHandler::onPeriodicAdvertisingSyncEstablished().
Definition at line 315 of file Events.h.
Constructor & Destructor Documentation
| PeriodicAdvertisingSyncEstablishedEvent | ( | ble_error_t | status, |
| periodic_sync_handle_t | syncHandle, | ||
| advertising_sid_t | sid, | ||
| const peer_address_type_t & | peerAddressType, | ||
| const address_t & | peerAddress, | ||
| const phy_t & | peerPhy, | ||
| uint16_t | advertisingInterval, | ||
| const clock_accuracy_t & | peerClockAccuracy | ||
| ) |
Create advertising sync event.
- Parameters:
-
success BLE_ERROR_NONE if synchronisation was achieved. syncHandle Advertising sync handle. sid Advertising set identifier. peerAddressType Peer address type. peerAddress Peer address. peerPhy PHY used for advertisements. advertisingInterval Periodic advertising interval. masterClockAccuracy Peer clock accuracy in parts per million.
Member Function Documentation
| const address_t& getPeerAddress | ( | ) | const |
| const peer_address_type_t& getPeerAddressType | ( | ) | const |
| const clock_accuracy_t& getPeerClockAccuracy | ( | ) | const |
| advertising_sid_t getSid | ( | ) | const |
| ble_error_t getStatus | ( | ) | const |
| periodic_sync_handle_t getSyncHandle | ( | ) | const |
Generated on Tue Jul 12 2022 13:55:40 by
1.7.2