docuemnted PHY api

pull/7899/head
paul-szczepanek-arm 2018-07-18 15:31:09 +01:00 committed by Vincent Coubard
parent e0ca4a093f
commit d64479a2ee
1 changed files with 15 additions and 0 deletions

View File

@ -299,6 +299,21 @@ class GapAdvertisingData;
* controller/stack. To catch all disconnection events, application code may
* set up an handler taking care of disconnection events by calling
* onDisconnection().
*
* * @par Modulation Schemes
*
* When supported by the host and controller you can select modulation schemes
* from available ones
* (@see BLUETOOTH SPECIFICATION Version 5.0 | Vol 1, Part A - 1.2). You may set
* preferred PHY, separately for RX and TX using setPreferredPhys(). You may also
* set the currently used PHY on a selected connection using setPhy(). Both of these
* are however only advisory and the controller is allowed to make its own decision
* on the best PHY to use based on your request, the peer's supported features and
* physical conditions. You may query the currently used PHY using readPhy() which
* will return the result through a call to the registered Gap::EventHandler.
* You may register the event handler with setEventHandler(). The events inform
* about the currently used PHY and of any changes to PHY which may be triggered
* autonomously byt the controller or by the peer.
*/
class Gap {
/*