[mynewt-nimble] 02/02: nimble/host: Improve GAP API description to sync transfer

[ry...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rymek pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git

commit d9a5d06f1d4d5bc4a71f6f51b725b3c2c434f692
Author: Łukasz Rymanowski <lu...@codecoup.pl>
AuthorDate: Wed Dec 18 09:35:37 2019 +0100

    nimble/host: Improve GAP API description to sync transfer
---
 nimble/host/include/host/ble_gap.h | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/nimble/host/include/host/ble_gap.h b/nimble/host/include/host/ble_gap.h
index 6af7e9d..20e7dab 100644
--- a/nimble/host/include/host/ble_gap.h
+++ b/nimble/host/include/host/ble_gap.h
@@ -1467,8 +1467,13 @@ int ble_gap_periodic_adv_sync_set_info(uint8_t instance,
 
 /**
  * Enables or disables sync transfer reception on specified connection.
- * When BLE_GAP_EVENT_PERIODIC_TRANSFER is sent transfer reception is terminated
- * on that connection.
+ * When sync transfer arrives, BLE_GAP_EVENT_PERIODIC_TRANSFER is sent to the user.
+ * After that, sync transfer reception on that connection is terminated and user needs
+ * to call this API again when expect to receive next sync transfers.
+ *
+ * Note: If ACL connection gets disconnected before sync transfer arrived, user will
+ * not receive BLE_GAP_EVENT_PERIODIC_TRANSFER. Instead, sync transfer reception
+ * is terminated by the host automatically.
  *
  * @param conn_handle        Handle identifying connection.
  * @param params             Parameters for enabled sync transfer reception.