This is an automated email from the ASF dual-hosted git repository.
janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git
The following commit(s) were added to refs/heads/master by this push:
new 795264b3d host/ble_gap.h: Extend description of
ble_gap_periodic_adv_sync_create
795264b3d is described below
commit 795264b3dbcd0951fd9681cf15e39badd41ce5b4
Author: Krzysztof Kopyściński <[email protected]>
AuthorDate: Fri Apr 5 09:27:27 2024 +0200
host/ble_gap.h: Extend description of ble_gap_periodic_adv_sync_create
Added to the description condition when the Periodic Sync actually
happens.
---
nimble/host/include/host/ble_gap.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/nimble/host/include/host/ble_gap.h
b/nimble/host/include/host/ble_gap.h
index 271933963..86e589c18 100644
--- a/nimble/host/include/host/ble_gap.h
+++ b/nimble/host/include/host/ble_gap.h
@@ -1826,7 +1826,10 @@ int ble_gap_periodic_adv_set_data(uint8_t instance,
const struct
ble_gap_periodic_adv_set_data_params *params);
/**
- * Performs the Synchronization procedure with periodic advertiser.
+ * Schedule the Synchronization procedure with periodic advertiser.
+ * Procedure is performed as soon as Extended Discovery procedure is started.
+ * If Extended Discovery is already active when issuing this procedure,
+ * it will be performed immediately. It is up to application to start Extended
Discovery.
*
* @param addr Peer address to synchronize with. If NULL than
* peers from periodic list are used.
