ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #9332 from jarlamsa/ble_doxygen_cleanup 

Update and cleanup BLE.h doxygen
pull/9369/head
Martin Kojtal 2019-01-14 09:43:16 +00:00 committed by GitHub
parent 23d75653ec d9e24b25e4
commit 9d4db2b0ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 190 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

198
features/FEATURE_BLE/ble/BLE.h
View File

@ -70,7 +70,7 @@ class BLEInstanceBase;
* Next, the signal handling/process mechanism should be set up. By design,
* Mbed BLE does not impose to the user an event handling/processing mechanism;
* however, it exposes APIs, which allows an application to compose its own:
* - onEventsToProcess(), whichs register a callback that
* - onEventsToProcess(), which registers a callback that
* the BLE subsystem will call when there is an event ready to be processed.
* - processEvents(), which processes all the events present in the BLE subsystem.
*
@ -81,10 +81,10 @@ class BLEInstanceBase;
* #include "ble/BLE.h"
*
* // declare the event queue, which the whole application will share.
* static EventQueue event_queue( 4 * EVENTS_EVENT_SIZE);
* static EventQueue event_queue(4 * EVENTS_EVENT_SIZE);
*
* // Function invoked when there is a BLE event available.
* // It put into the event queue the processing of the event(s)
* // Event processing is put into the event queue.
* void schedule_ble_processing(BLE::OnEventsToProcessCallbackContext* context) {
* event_queue.call(callback(&(context->ble), &BLE::processEvents));
* }
@ -424,6 +424,8 @@ public:
* are thin wrappers around a transport object (that is, ptr. to
* BLEInstanceBase).
*
* @param[in] instanceID BLE Instance ID to get.
*
* It is better to create BLE objects as singletons accessed through the
* Instance() method. If multiple BLE handles are constructed for the same
* interface (using this constructor), they share the same underlying
@ -442,7 +444,7 @@ public:
* MCU might wake up several times to service the stack before returning
* control to the caller.
*
* @deprecated This function block the CPU prefer to use the pair
* @deprecated This function blocks the CPU. Use the pair
* onEventsToProcess() and processEvents().
*/
MBED_DEPRECATED("Use BLE::processEvents() and BLE::onEventsToProcess().")
@ -451,6 +453,10 @@ public:
/**
* Set the BTLE MAC address and type.
*
* @param[in] type Type of the address to set.
* @param[in] address Value of the address to set. It is ordered in
* little endian.
*
* @return BLE_ERROR_NONE on success.
*
* @deprecated You should use the parallel API from Gap directly, refer to
@ -466,6 +472,9 @@ public:
/**
* Fetch the Bluetooth Low Energy MAC address and type.
*
* @param[out] typeP Type of the current address set.
* @param[out] address Value of the current address.
*
* @return BLE_ERROR_NONE on success.
*
* @deprecated You should use the parallel API from Gap directly and refer to
@ -483,6 +492,8 @@ public:
/**
* Set the GAP advertising mode to use for this device.
*
* @param[in] advType New type of advertising to use.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setAdvertisingType(). A former call to
* ble.setAdvertisingType(...) should be replaced with
@ -492,6 +503,8 @@ public:
void setAdvertisingType(GapAdvertisingParams::AdvertisingType advType);
/**
* Set the advertising interval.
*
* @param[in] interval
* Advertising interval in units of milliseconds. Advertising
* is disabled if interval is 0. If interval is smaller than
@ -521,6 +534,9 @@ public:
void setAdvertisingInterval(uint16_t interval);
/**
* Get the minimum advertising interval in milliseconds, which can be used
* for connectable advertising types.
*
* @return Minimum Advertising interval in milliseconds.
*
* @deprecated You should use the parallel API from Gap directly, refer to
@ -535,6 +551,9 @@ public:
}
/**
* Get the minimum advertising interval in milliseconds, which can be
* used for nonconnectable advertising type.
*
* @return Minimum Advertising interval in milliseconds for nonconnectible mode.
*
* @deprecated You should use the parallel API from Gap directly, refer to
@ -549,6 +568,8 @@ public:
}
/**
* Get the maximum advertising interval in milliseconds.
*
* @return Maximum Advertising interval in milliseconds.
*
* @deprecated You should use the parallel API from Gap directly, refer to
@ -563,6 +584,10 @@ public:
}
/**
* Set the advertising duration.
*
* A timeout event is genenerated once the advertising period expired.
*
* @param[in] timeout
* Advertising timeout (in seconds) between 0x1 and 0x3FFF (1
* and 16383). Use 0 to disable the advertising timeout.
@ -581,6 +606,8 @@ public:
* directly; there are other APIs to tweak advertisement parameters
* individually (see above).
*
* @param[in] advParams The new advertising parameters.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setAdvertisingParams(). A former call to
* ble.setAdvertisingParams(...) should be replaced with
@ -590,6 +617,8 @@ public:
void setAdvertisingParams(const GapAdvertisingParams &advParams);
/**
* Get the current advertising parameters.
*
* @return Read back advertising parameters. Useful for storing and
* restoring parameters rapidly.
*
@ -612,6 +641,9 @@ public:
* GapAdvertisingData::Flags for valid flags. Multiple
* flags may be specified in combination.
*
* @return BLE_ERROR_NONE if the data was successfully added to the
* advertising payload.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::accumulateAdvertisingPayload(uint8_t). A former call to
* ble.accumulateAdvertisingPayload(flags) should be replaced with
@ -629,6 +661,9 @@ public:
* @param[in] app
* The appearance of the peripheral.
*
* @return BLE_ERROR_NONE if the data was successfully added to the
* advertising payload.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::accumulateAdvertisingPayload(GapAdvertisingData::Appearance).
* A former call to ble.accumulateAdvertisingPayload(appearance)
@ -648,6 +683,9 @@ public:
* The max transmit power to be used by the controller. This
* is only a hint.
*
* @return BLE_ERROR_NONE if the data was successfully added to the
* advertising payload.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::accumulateAdvertisingPayloadTxPower(). A former call to
* ble.accumulateAdvertisingPayloadTxPower(txPower) should be replaced with
@ -666,6 +704,9 @@ public:
* @param data Data bytes.
* @param len Data length.
*
* @return BLE_ERROR_NONE if the advertisement payload was updated based on
* matching AD type; otherwise, an appropriate error.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::accumulateAdvertisingPayload(GapAdvertisingData::DataType, const uint8_t, uint8_t).
* A former call to ble.accumulateAdvertisingPayload(...) should
@ -679,6 +720,10 @@ public:
* underlying stack. It would be uncommon for this API to be used directly;
* there are other APIs to build an advertisement payload (see above).
*
* @param[in] advData Advertising data to set.
*
* @return BLE_ERROR_NONE if the advertising data was set successfully.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::setAdvertisingData(). A former call to
* ble.setAdvertisingData(...) should be replaced with
@ -688,6 +733,8 @@ public:
ble_error_t setAdvertisingData(const GapAdvertisingData &advData);
/**
* Get a reference to the current advertising payload.
*
* @return Read back advertising data. Useful for storing and
* restoring payload.
*
@ -737,6 +784,9 @@ public:
* @param[in] data Data bytes.
* @param[in] len Data length.
*
* @return BLE_ERROR_NONE if the data was successfully added to the scan
* response payload.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::accumulateScanResponse(). A former call to
* ble.accumulateScanResponse(...) should be replaced with
@ -760,6 +810,9 @@ public:
/**
* Start advertising.
*
* @return BLE_ERROR_NONE if the advertising procedure successfully
* started.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::startAdvertising(). A former call to
* ble.startAdvertising(...) should be replaced with
@ -771,6 +824,9 @@ public:
/**
* Stop advertising.
*
* @return BLE_ERROR_NONE if the advertising procedure has been successfully
* stopped.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::stopAdvertising(). A former call to
* ble.stopAdvertising(...) should be replaced with
@ -781,6 +837,7 @@ public:
/**
* Set up parameters for GAP scanning (observer mode).
*
* @param[in] interval
* Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
* @param[in] window
@ -791,6 +848,8 @@ public:
* Set to True if active-scanning is required. This is used to fetch the
* scan response from a peer if possible.
*
* @return BLE_ERROR_NONE if the scan parameters were correctly set.
*
* The scanning window divided by the interval determines the duty cycle for
* scanning. For example, if the interval is 100ms and the window is 10ms,
* then the controller will scan for 10 percent of the time. It is possible
@ -818,9 +877,12 @@ public:
/**
* Set up the scanInterval parameter for GAP scanning (observer mode).
*
* @param[in] interval
* Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
*
* @return BLE_ERROR_NONE if the scan interval was correctly set.
*
* The scanning window divided by the interval determines the duty cycle for
* scanning. For example, if the interval is 100ms and the window is 10ms,
* then the controller will scan for 10 percent of the time. It is possible
@ -841,9 +903,12 @@ public:
/**
* Set up the scanWindow parameter for GAP scanning (observer mode).
*
* @param[in] window
* Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
*
* @return BLE_ERROR_NONE if the scan window was correctly set.
*
* The scanning window divided by the interval determines the duty cycle for
* scanning. For example, if the interval is 100ms and the window is 10ms,
* then the controller will scan for 10 percent of the time. It is possible
@ -864,9 +929,12 @@ public:
/**
* Set up parameters for GAP scanning (observer mode).
*
* @param[in] timeout
* Scan timeout (in seconds) between 0x0001 and 0xFFFF; 0x0000 disables timeout.
*
* @return BLE_ERROR_NONE if the scan timeout was correctly set.
*
* The scanning window divided by the interval determines the duty cycle for
* scanning. For example, if the interval is 100ms and the window is 10ms,
* then the controller will scan for 10 percent of the time. It is possible
@ -889,6 +957,7 @@ public:
/**
* Set up parameters for GAP scanning (observer mode).
*
* @param[in] activeScanning
* Set to True if active-scanning is required. This is used to fetch the
* scan response from a peer if possible.
@ -913,6 +982,9 @@ public:
* receiving every advertisement report. This can be passed in
* as NULL, in which case scanning may not be enabled at all.
*
* @return BLE_ERROR_NONE if the device successfully started the scan
* procedure.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::startScan(). A former call to
* ble.startScan(callback) should be replaced with
@ -922,7 +994,19 @@ public:
ble_error_t startScan(void (*callback)(const Gap::AdvertisementCallbackParams_t *params));
/**
* Same as above, but this takes an (object, method) pair for a callback.
* Start the scanning procedure.
*
* Packets received during the scan procedure are forwarded to the
* scan packet handler passed as argument to this function.
*
* @param[in] object Instance used to invoke @p callbackMember.
*
* @param[in] memberCallback Advertisement packet event handler. Upon
* reception of an advertising packet, the packet is forwarded to @p
* callback invoked from @p object.
*
* @return BLE_ERROR_NONE if the device successfully started the scan
* procedure.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::startScan(). A former call to
@ -936,7 +1020,7 @@ public:
/**
* Stop scanning. The current scanning parameters remain in effect.
*
* @retval BLE_ERROR_NONE if successfully stopped scanning procedure.
* @return BLE_ERROR_NONE if successfully stopped scanning procedure.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::stopScan(). A former call to
@ -951,6 +1035,7 @@ public:
/**
* Create a connection (GAP Link Establishment).
*
* @param peerAddr
* 48-bit address, LSB format.
* @param peerAddrType
@ -959,6 +1044,7 @@ public:
* Connection parameters.
* @param scanParams
* Parameters to use while scanning for the peer.
*
* @return BLE_ERROR_NONE if connection establishment procedure is started
* successfully. The onConnection callback (if set) is invoked upon
* a connection event.
@ -984,6 +1070,14 @@ public:
* @param[in] connectionHandle
* @param[in] reason
* The reason for disconnection; sent back to the peer.
*
* @return BLE_ERROR_NONE if the disconnection procedure successfully
* started.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* GAP::disconnect(). A former call to
* ble.disconnect(...) should be replaced with
* ble.gap().disconnect(...).
*/
MBED_DEPRECATED("Use ble.gap().disconnect(...)")
ble_error_t disconnect(Gap::Handle_t connectionHandle, Gap::DisconnectionReason_t reason);
@ -996,6 +1090,9 @@ public:
* @param reason
* The reason for disconnection; sent back to the peer.
*
* @return BLE_ERROR_NONE if the disconnection procedure successfully
* started.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::disconnect(). A former call to
* ble.disconnect(reason) should be replaced with
@ -1012,12 +1109,14 @@ public:
* Returns the current Gap state of the device using a bitmask that
* describes whether the device is advertising or connected.
*
* @return The current GAP state of the device.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::getState(). A former call to
* ble.getGapState() should be replaced with
* ble.gap().getState().
*/
MBED_DEPRECATED("Use ble.gap().getGapState(...)")
MBED_DEPRECATED("Use ble.gap().getState()")
Gap::GapState_t getGapState(void) const;
/**
@ -1051,6 +1150,9 @@ public:
* @param[in] params
* The structure containing the desired parameters.
*
* @return BLE_ERROR_NONE if the preferred connection parameters were set
* correctly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setPreferredConnectionParams(). A former call to
* ble.setPreferredConnectionParams() should be replaced with
@ -1064,14 +1166,18 @@ public:
/**
* Update connection parameters while in the peripheral role.
*
* @details In the peripheral role, this will send the corresponding L2CAP request to the connected peer and wait for
* the central to perform the procedure.
*
* @param[in] handle
* Connection Handle
* @param[in] params
* Pointer to desired connection parameters. If NULL is provided on a peripheral role,
* the parameters in the PPCP characteristic of the GAP service will be used instead.
*
* @return BLE_ERROR_NONE if the connection parameters were updated correctly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::updateConnectionParams(). A former call to
* ble.updateConnectionParams() should be replaced with
@ -1082,9 +1188,12 @@ public:
/**
* Set the device name characteristic in the Gap service.
*
* @param[in] deviceName
* The new value for the device-name. This is a UTF-8 encoded, <b>NULL-terminated</b> string.
*
* @return BLE_ERROR_NONE if the device name was set correctly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setDeviceName(). A former call to
* ble.setDeviceName() should be replaced with
@ -1098,6 +1207,7 @@ public:
/**
* Get the value of the device name characteristic in the Gap service.
*
* @param[out] deviceName
* Pointer to an empty buffer where the UTF-8 *non NULL-
* terminated* string will be placed. Set this
@ -1109,6 +1219,9 @@ public:
* (on output) the complete device name length (without the
* null terminator).
*
* @return BLE_ERROR_NONE if the device name was fetched correctly from the
* underlying BLE stack.
*
* @note If the device name is longer than the size of the supplied buffer,
* the length will return the complete device name length and not the
* number of bytes actually returned in deviceName. The application may
@ -1127,9 +1240,12 @@ public:
/**
* Set the appearance characteristic in the Gap service.
*
* @param[in] appearance
* The new value for the device-appearance.
*
* @return BLE_ERROR_NONE if the new appearance was set correctly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setAppearance(). A former call to
* ble.setAppearance() should be replaced with
@ -1143,9 +1259,13 @@ public:
/**
* Get the appearance characteristic in the Gap service.
*
* @param[out] appearanceP
* The new value for the device-appearance.
*
* @return BLE_ERROR_NONE if the device-appearance was fetched correctly
* from the underlying BLE stack.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::getAppearance(). A former call to
* ble.getAppearance() should be replaced with
@ -1159,8 +1279,12 @@ public:
/**
* Set the radio's transmit power.
*
* @param[in] txPower Radio transmit power in dBm.
*
* @return BLE_ERROR_NONE if the new radio's transmit power was set
* correctly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setTxPower(). A former call to
* ble.setTxPower() should be replaced with
@ -1189,6 +1313,12 @@ public:
* Add a service declaration to the local server ATT table. Also add the
* characteristics contained within.
*
* @param[in] service The service to be added; attribute handle of services,
* characteristic and characteristic descriptors are updated by the
* process.
*
* @return BLE_ERROR_NONE if the service was successfully added.
*
* @deprecated You should use the parallel API from GattServer directly, refer to
* GattServer::addService(). A former call
* to ble.addService() should be replaced with
@ -1202,6 +1332,7 @@ public:
/**
* Read the value of a characteristic from the local GattServer.
*
* @param[in] attributeHandle
* Attribute handle for the value attribute of the characteristic.
* @param[out] buffer
@ -1228,6 +1359,7 @@ public:
/**
* Read the value of a characteristic from the local GattServer.
*
* @param[in] connectionHandle
* Connection Handle.
* @param[in] attributeHandle
@ -1356,7 +1488,7 @@ public:
* call to ble.initializeSecurity(...) should be replaced with
* ble.securityManager().init(...).
*/
MBED_DEPRECATED("Use ble.gattServer().write(...)")
MBED_DEPRECATED("Use ble.securityManager().init(...)")
ble_error_t initializeSecurity(
bool enableBonding = true,
bool requireMITM = true,
@ -1409,6 +1541,8 @@ public:
* Set up a callback for timeout events. Refer to Gap::TimeoutSource_t for
* possible event types.
*
* @param[in] timeoutCallback Event handler being registered.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::onTimeout(). A former call
* to ble.onTimeout(callback) should be replaced with
@ -1420,6 +1554,8 @@ public:
/**
* Set up a callback for connection events. Refer to Gap::ConnectionEventCallback_t.
*
* @param[in] connectionCallback Event handler being registered.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::onConnection(). A former call
* to ble.onConnection(callback) should be replaced with
@ -1431,6 +1567,8 @@ public:
/**
* Append to a chain of callbacks to be invoked upon GAP disconnection.
*
* @param[in] disconnectionCallback Event handler being registered.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::onDisconnection(). A former call
* to ble.onDisconnection(callback) should be replaced with
@ -1443,6 +1581,9 @@ public:
* The same as onDisconnection() but allows an object reference and member function
* to be added to the chain of callbacks.
*
* @param[in] tptr Instance used to invoke mptr.
* @param[in] mptr Event handler being registered.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::onDisconnection(). A former call
* to ble.onDisconnection(callback) should be replaced with
@ -1483,6 +1624,8 @@ public:
* Add a callback for the GATT event DATA_SENT (which is triggered when
* updates are sent out by GATT in the form of notifications).
*
* @param[in] callback Event handler being registered.
*
* @note It is possible to chain together multiple onDataSent callbacks
* (potentially from different modules of an application) to receive updates
* to characteristics.
@ -1505,6 +1648,11 @@ public:
* The same as onDataSent() but allows an object reference and member function
* to be added to the chain of callbacks.
*
* @param[in] objPtr Pointer to the instance that is used to invoke the
* event handler.
* @param[in] memberPtr Event handler being registered. It is a member
* function.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onDataSent(). A former call
* to ble.onDataSent(...) should be replaced with
@ -1524,6 +1672,8 @@ public:
* For a Central, this callback is triggered when a response is received for
* a write request.
*
* @param[in] callback The event handler being registered.
*
* @note It is possible to chain together multiple onDataWritten callbacks
* (potentially from different modules of an application) to receive updates
* to characteristics. Many services, such as DFU and UART, add their own
@ -1547,6 +1697,12 @@ public:
* The same as onDataWritten() but allows an object reference and member function
* to be added to the chain of callbacks.
*
* @param[in] objPtr Pointer to the instance that is used to invoke the
* event handler (@p memberPtr).
* @param[in] memberPtr Event handler being registered. It is a member
* function.
*
*
* @deprecated You should use the parallel API from GattServer directly, refer to
* GattServer::onDataWritten(). A former call
* to ble.onDataWritten(...) should be replaced with
@ -1575,6 +1731,8 @@ public:
* @note It is also possible to set up a callback into a member function of
* some object.
*
* @param[in] callback Event handler being registered.
*
* @return BLE_ERROR_NOT_IMPLEMENTED if this functionality isn't available;
* else BLE_ERROR_NONE.
*
@ -1593,6 +1751,14 @@ public:
* The same as onDataRead() but allows an object reference and member function
* to be added to the chain of callbacks.
*
* @param[in] objPtr Pointer to the instance that is used to invoke the
* event handler (@p memberPtr).
* @param[in] memberPtr Event handler being registered. It is a member
* function.
*
* @return BLE_ERROR_NOT_IMPLEMENTED if this functionality isn't available;
* else BLE_ERROR_NONE.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onDataRead(). A former call
* to ble.onDataRead(...) should be replaced with
@ -1609,6 +1775,8 @@ public:
* Set up a callback for when notifications or indications are enabled for a
* characteristic on the local GattServer.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onUpdatesEnabled(). A former call
* to ble.onUpdatesEnabled(callback) should be replaced with
@ -1624,6 +1792,8 @@ public:
* Set up a callback for when notifications or indications are disabled for a
* characteristic on the local GattServer.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onUpdatesDisabled(). A former call
* to ble.onUpdatesDisabled(callback) should be replaced with
@ -1639,6 +1809,8 @@ public:
* Set up a callback for when the GATT server receives a response for an
* indication event sent previously.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onConfirmationReceived(). A former call
* to ble.onConfirmationReceived(callback) should be replaced with
@ -1657,6 +1829,8 @@ public:
* security request: bool allowBonding, bool requireMITM and
* SecurityIOCapabilities_t.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::onSecuritySetupInitiated(). A former
* call to ble.onSecuritySetupInitiated(callback) should be replaced with
@ -1674,6 +1848,8 @@ public:
* devices. The callback is passed in the success/failure status of the
* security setup procedure.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::onSecuritySetupCompleted(). A former
* call to ble.onSecuritySetupCompleted(callback) should be replaced with
@ -1693,6 +1869,8 @@ public:
* or both sides. The callback is passed in a SecurityManager::SecurityMode_t according
* to the level of security in effect for the secured link.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::onLinkSecured(). A former
* call to ble.onLinkSecured(callback) should be replaced with
@ -1708,6 +1886,8 @@ public:
* Set up a callback for successful bonding, meaning that link-specific security
* context is stored persistently for a peer device.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::onSecurityContextStored(). A former
* call to ble.onSecurityContextStored(callback) should be replaced with
@ -1726,6 +1906,8 @@ public:
* a passkey (or PIN) to authenticate the connection
* attempt.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::onPasskeyDisplay(). A former
* call to ble.onPasskeyDisplay(callback) should be replaced with