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 13:34:43 +00:00 committed by Vincent Coubard
parent 9fc577d6e6
commit 360336c89c
1 changed files with 46 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2340,9 +2340,9 @@ public:
/* scanning */ /* scanning */
/** Set new scan parameters /** Set new scan parameters.
* *
* @param params Scan paramters * @param params Scan parameters, @see GapScanParameters for details.
* @return BLE_ERROR_NONE on success. * @return BLE_ERROR_NONE on success.
*/ */
virtual ble_error_t setScanParameters( virtual ble_error_t setScanParameters(
@ -2353,11 +2353,17 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED; return BLE_ERROR_NOT_IMPLEMENTED;
}; };
/** /** Start scanning.
* FIXME *
* @param filtering * @param filtering Filtering policy.
* @param duration * @param duration How long to scan for. Special value 0 means scan forever.
* @param period * @param period How long to scan for in single period. If the period is 0 and duration
* is nonzero the scan will last for single duration.
*
* @note When the duration and period parameters are non-zero scanning will last for
* the duration within the period. After the scan period has expired a new scan period
* will begin and scanning. This will repeat until stopScan() is called.
*
* @return BLE_ERROR_NONE on success. * @return BLE_ERROR_NONE on success.
*/ */
virtual ble_error_t startScan( virtual ble_error_t startScan(
@ -2370,13 +2376,16 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED; return BLE_ERROR_NOT_IMPLEMENTED;
}; };
/** /** Synchronise with periodic advertising from an advertiser and begin receiving periodic
* FIXME * advertising packets.
* @param peerAddressType *
* @param peerAddress * @param peerAddressType Peer address type.
* @param sid * @param peerAddress Peer address.
* @param maxPacketSkip * @param sid Advertiser set identifier.
* @param timeoutMs * @param maxPacketSkip Number of consecutive periodic advertising packets that the receiver
* may skip after successfully receiving a periodic advertising packet.
* @param timeout Maximum permitted time between successful receptions. If this time is
* exceeded, synchronisation is lost.
* @return BLE_ERROR_NONE on success. * @return BLE_ERROR_NONE on success.
*/ */
virtual ble_error_t createSync( virtual ble_error_t createSync(
@ -2390,10 +2399,13 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED; return BLE_ERROR_NOT_IMPLEMENTED;
} }
/** /** Synchronise with periodic advertising from an advertiser and begin receiving periodic
* FIXME * advertising packets. Use periodic advertising sync list to determine who to sync with.
* @param maxPacketSkip *
* @param timeoutMs * @param maxPacketSkip Number of consecutive periodic advertising packets that the receiver
* may skip after successfully receiving a periodic advertising packet.
* @param timeout Maximum permitted time between successful receives.
* If this time is exceeded, synchronisation is lost.
* @return BLE_ERROR_NONE on success. * @return BLE_ERROR_NONE on success.
*/ */
virtual ble_error_t createSync( virtual ble_error_t createSync(
@ -2404,8 +2416,8 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED; return BLE_ERROR_NOT_IMPLEMENTED;
} }
/** /** Cancel sync attempt.
* FIXME *
* @return BLE_ERROR_NONE on success. * @return BLE_ERROR_NONE on success.
*/ */
virtual ble_error_t cancelCreateSync() virtual ble_error_t cancelCreateSync()
@ -2414,20 +2426,23 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED; return BLE_ERROR_NOT_IMPLEMENTED;
} }
/** /** Stop reception of the periodic advertising identified by the handle.
* FIXME *
* @param handle Periodic advertising synchronisation handle.
* @return BLE_ERROR_NONE on success.
*/ */
virtual ble_error_t terminateSync(PeriodicSyncHandle_t handle) virtual ble_error_t terminateSync(
{ PeriodicSyncHandle_t handle
) {
/* Requesting action from porter(s): override this API if this capability is supported. */ /* Requesting action from porter(s): override this API if this capability is supported. */
return BLE_ERROR_NOT_IMPLEMENTED; return BLE_ERROR_NOT_IMPLEMENTED;
} }
/** /** Add device to the periodic advertiser list. Cannot be called when sync is ongoing.
* FIXME *
* @param peerAddressType * @param peerAddressType Peer address type.
* @param peerAddress * @param peerAddress Peer address.
* @param sid * @param sid Advertiser set identifier.
* @return BLE_ERROR_NONE on success. * @return BLE_ERROR_NONE on success.
*/ */
virtual ble_error_t addDeviceToPeriodicAdvertiserList( virtual ble_error_t addDeviceToPeriodicAdvertiserList(
@ -2439,7 +2454,8 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED; return BLE_ERROR_NOT_IMPLEMENTED;
} }
/** /** Remove device from the periodic advertiser list. Cannot be called when sync is ongoing.
*
* @param peerAddressType Peer address type. * @param peerAddressType Peer address type.
* @param peerAddress Peer address. * @param peerAddress Peer address.
* @param sid Advertiser set identifier. * @param sid Advertiser set identifier.