ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs

pull/8738/head
paul-szczepanek-arm 2018-11-13 15:45:25 +00:00 committed by Vincent Coubard
parent da22df74bc
commit e9177fa233
1 changed files with 44 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
features/FEATURE_BLE/ble/Gap.h
View File

@ -1289,6 +1289,8 @@ public:
(void) event; (void) event;
} }
/** Event generated when attempts to connect end (successfully or not).
*/
struct ConnectionCompleteEvent { struct ConnectionCompleteEvent {
/** Create a connection complete event. /** Create a connection complete event.
* *
@ -1408,8 +1410,20 @@ public:
(void)event; (void)event;
} }
/** Event generated when we first receive a periodic advertisement.
*/
struct PeriodicAdvertisingSyncEstablishedEvent { struct PeriodicAdvertisingSyncEstablishedEvent {
/** Create advertising sync event.
*
* @param success BLE_ERROR_NONE if connection succeeded.
* @param syncHandle Advertising sync handle.
* @param sid Advertising set identifier.
* @param peerAddressType Peer address type.
* @param peerAddress Peer address.
* @param peerPhy Phy used for advertisements.
* @param advertisingInterval Periodic advertising interval.
* @param masterClockAccuracy Peer clock accuracy in parts per million.
*/
PeriodicAdvertisingSyncEstablishedEvent( PeriodicAdvertisingSyncEstablishedEvent(
ble_error_t status, ble_error_t status,
ble::periodic_sync_handle_t syncHandle, ble::periodic_sync_handle_t syncHandle,
@ -1480,19 +1494,32 @@ public:
ble::clock_accuracy_t peerClockAccuracy; ble::clock_accuracy_t peerClockAccuracy;
}; };
/** Called when first advertising packet in periodic advertising is received.
*
* @param event Periodic advertising sync event @see PeriodicAdvertisingSyncEstablishedEvent.
*/
virtual void onPeriodicAdvertisingSyncEstablished( virtual void onPeriodicAdvertisingSyncEstablished(
const PeriodicAdvertisingSyncEstablishedEvent &event const PeriodicAdvertisingSyncEstablishedEvent &event
) ) {
{
(void) event; (void) event;
} }
/** Event generated when periodic advertising packet is received.
*/
struct PeriodicAdvertisingReportEvent { struct PeriodicAdvertisingReportEvent {
/** Create periodic advertising report event.
*
* @param syncHandle Periodic advertising sync handle
* @param txPower TX power.
* @param rssi Received signal strength.
* @param dataStatus Status to indicate the completeness of the payload.
* @param payload Periodic advertisement payload.
*/
PeriodicAdvertisingReportEvent( PeriodicAdvertisingReportEvent(
ble::periodic_sync_handle_t syncHandle, ble::periodic_sync_handle_t syncHandle,
ble::advertising_power_t txPower, ble::advertising_power_t txPower,
ble::rssi_t rssi, ble::rssi_t rssi,
const ble::advertising_data_status_t &dataStatus, ble::advertising_data_status_t dataStatus,
const mbed::Span<const uint8_t> &payload const mbed::Span<const uint8_t> &payload
) : ) :
syncHandle(syncHandle), syncHandle(syncHandle),
@ -1534,14 +1561,26 @@ public:
mbed::Span<const uint8_t> payload; mbed::Span<const uint8_t> payload;
}; };
/** Called when a periodic advertising packet is received.
*
* @param event Periodic advertisement event.
*/
virtual void onPeriodicAdvertisingReportEvent( virtual void onPeriodicAdvertisingReportEvent(
const PeriodicAdvertisingReportEvent & event const PeriodicAdvertisingReportEvent & event
) { ) {
(void) event; (void) event;
} }
/** Event generated when periodic advertising sync is lost.
*/
struct PeriodicAdvertisingSyncLoss { struct PeriodicAdvertisingSyncLoss {
PeriodicAdvertisingSyncLoss(ble::periodic_sync_handle_t syncHandle) : /** Create periodic advertising sync loss event.
*
* @param syncHandle Periodic advertising sync handle.
*/
PeriodicAdvertisingSyncLoss(
ble::periodic_sync_handle_t syncHandle
) :
syncHandle(syncHandle) { } syncHandle(syncHandle) { }
ble::periodic_sync_handle_t getSyncHandle() const ble::periodic_sync_handle_t getSyncHandle() const