Sam Musso / BLE_API

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.

Fork of BLE_API by Bluetooth Low Energy

Diff: public/GattCharacteristic.h

Revision:
354:cfe0a8bafaaa
Parent:
350:64b656246a72
Child:
355:58a4b9423365
--- a/public/GattCharacteristic.h	Fri May 08 15:35:46 2015 +0100
+++ b/public/GattCharacteristic.h	Fri May 08 15:35:46 2015 +0100
@@ -349,6 +349,11 @@
     }
 
 public:
+    /**
+     * Setup the minimum security (mode and level) requirements for access to the characteristic's value attribute.
+     *
+     * @param securityMode Can be one of encryption or signing, with or without protection for MITM (man in the middle attacks).
+     */
     void requireSecurity(ble_gatt_char_required_security_t securityMode) {
         _requiredSecurity = securityMode;
     }