File tree Expand file tree Collapse file tree 2 files changed +10
-5
lines changed Expand file tree Collapse file tree 2 files changed +10
-5
lines changed Original file line number Diff line number Diff line change @@ -627,10 +627,15 @@ struct AdvertisingEndEvent {
627
627
/* * Create an extended advertising end event.
628
628
*
629
629
* @param advHandle Advertising set handle.
630
- * @param connection Connection handle.
631
- * @param completed_events Number of events created during before advertising end.
630
+ * @param connection Connection handle - only valid if connected is True.
631
+ * @param completed_events Number of events created during before advertising end - only valid
632
+ * if advertising end has been caused by BLE_ERROR_LIMIT_REACHED, not the local user.
633
+ * Check getStatus().
632
634
* @param connected True if connection has been established.
633
- * @param status Error code if stop command failed.
635
+ * @param status Error code showing the reason for event. BLE_ERROR_LIMIT_REACHED if set number
636
+ * of events have been reached. BLE_ERROR_TIMEOUT if set time has elapsed.
637
+ * BLE_ERROR_SUCCESS if connection occurred or user ended the set. Check isConnected()
638
+ * to determine which.
634
639
*/
635
640
AdvertisingEndEvent (
636
641
advertising_handle_t advHandle,
Original file line number Diff line number Diff line change @@ -193,9 +193,9 @@ struct PalGapEventHandler {
193
193
194
194
/* * Called when advertising set stops advertising.
195
195
*
196
- * @param status SUCCESS if connection has been established.
196
+ * @param status SUCCESS if connection has been established or if stopped by user .
197
197
* @param advertising_handle Advertising set handle.
198
- * @param advertising_handle Connection handle.
198
+ * @param advertising_handle Connection handle. Set to invalid handle if no connection made.
199
199
* @param number_of_completed_extended_advertising_events Number of events created during before advertising end.
200
200
*/
201
201
virtual void on_advertising_set_terminated (
You can’t perform that action at this time.
0 commit comments