Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Gap::EventHandler Struct Reference
Definition of the general handler of Gap related events. More...
#include <Gap.h>
Public Member Functions | |
| virtual void | onReadPhy (ble_error_t status, Handle_t connectionHandle, Phy_t txPhy, Phy_t rxPhy) |
| Function invoked when the current transmitter and receiver PHY have been read for a given connection. | |
| virtual void | onPhyUpdateComplete (ble_error_t status, Handle_t connectionHandle, Phy_t txPhy, Phy_t rxPhy) |
| Function invoked when the update process of the PHY has been completed. | |
Protected Member Functions | |
| ~EventHandler () | |
| Prevent polymorphic deletion and avoid uncessery virtual destructor as the Gap class will never delete the instance it contains. | |
Detailed Description
Definition of the general handler of Gap related events.
Definition at line 1127 of file Gap.h.
Constructor & Destructor Documentation
| ~EventHandler | ( | ) | [protected] |
Member Function Documentation
| virtual void onPhyUpdateComplete | ( | ble_error_t | status, |
| Handle_t | connectionHandle, | ||
| Phy_t | txPhy, | ||
| Phy_t | rxPhy | ||
| ) | [virtual] |
Function invoked when the update process of the PHY has been completed.
The process can be initiated by a call to the function setPhy, the local bluetooth subsystem or the peer.
- Parameters:
-
status Status of the operation: BLE_ERROR_NONE in case of success or an appropriate error code. connectionHandle,: The handle of the connection on which the operation was made. txPhy PHY used by the transmitter. rxPhy PHY used by the receiver.
- Note:
- Success doesn't mean the PHY has been updated it means both ends have negociated the best phy according to their configuration and capabilities. The PHY currently used are present in the txPhy and rxPhy parameters.
| virtual void onReadPhy | ( | ble_error_t | status, |
| Handle_t | connectionHandle, | ||
| Phy_t | txPhy, | ||
| Phy_t | rxPhy | ||
| ) | [virtual] |
Function invoked when the current transmitter and receiver PHY have been read for a given connection.
- Parameters:
-
status Status of the operation: BLE_ERROR_NONE in case of success or an appropriate error code. connectionHandle,: The handle of the connection for which the PHYs have been read. txPhy PHY used by the transmitter. rxPhy PHY used by the receiver.
Generated on Tue Aug 9 2022 00:37:33 by
1.7.2