YUFEI JIANG / BLE_API_Tiny_BLE

BLE_API_Tiny_BLE

Dependents:   CSSE4011_BLE_IMU

Fork of BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Revision 354:cfe0a8bafaaa, committed 2015-05-08

Comitter:
rgrover1
Date:
Fri May 08 15:35:46 2015 +0100
Parent:
353:5ed63cda3038
Child:
355:58a4b9423365
Commit message:
Synchronized with git rev 7c4463b8
Author: Rohit Grover
add comment block for GattCharacteristic::requireSecurity()

Changed in this revision

public/GattCharacteristic.h Show annotated file Show diff for this revision Revisions of this file 
--- 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;
     }