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

clarify documentation for adv stop event

pull/14747/head
Paul Szczepanek 2021-06-09 13:56:39 +01:00
parent 88ede0002d
commit c4585b977d
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
connectivity/FEATURE_BLE/include/ble/gap/Events.h
View File

@ -627,10 +627,15 @@ struct AdvertisingEndEvent {
/** Create an extended advertising end event. /** Create an extended advertising end event.
* *
* @param advHandle Advertising set handle. * @param advHandle Advertising set handle.
* @param connection Connection handle. * @param connection Connection handle - only valid if connected is True.
* @param completed_events Number of events created during before advertising end. * @param completed_events Number of events created during before advertising end - only valid
* if advertising end has been caused by BLE_ERROR_LIMIT_REACHED, not the local user.
* Check getStatus().
* @param connected True if connection has been established. * @param connected True if connection has been established.
* @param status Error code if stop command failed. * @param status Error code showing the reason for event. BLE_ERROR_LIMIT_REACHED if set number
* of events have been reached. BLE_ERROR_TIMEOUT if set time has elapsed.
* BLE_ERROR_SUCCESS if connection occurred or user ended the set. Check isConnected()
* to determine which.
*/ */
AdvertisingEndEvent( AdvertisingEndEvent(
advertising_handle_t advHandle, advertising_handle_t advHandle,

4
connectivity/FEATURE_BLE/source/pal/PalGap.h
View File

@ -193,9 +193,9 @@ public:
/** Called when advertising set stops advertising. /** Called when advertising set stops advertising.
* *
* @param status SUCCESS if connection has been established. * @param status SUCCESS if connection has been established or if stopped by user.
* @param advertising_handle Advertising set handle. * @param advertising_handle Advertising set handle.
* @param advertising_handle Connection handle. * @param advertising_handle Connection handle. Set to invalid handle if no connection made.
* @param number_of_completed_extended_advertising_events Number of events created during before advertising end. * @param number_of_completed_extended_advertising_events Number of events created during before advertising end.
*/ */
virtual void on_advertising_set_terminated( virtual void on_advertising_set_terminated(