Diff: source/nRF5xSecurityManager.h

Revision:

599:3e66e1eb264d

Parent:

598:814c1ce92947

Child:

613:cbc548e9df98

--- a/source/nRF5xSecurityManager.h	Mon Jan 11 10:19:35 2016 +0000
+++ b/source/nRF5xSecurityManager.h	Mon Jan 11 10:19:36 2016 +0000
@@ -79,13 +79,28 @@
     nRF5xSecurityManager(const nRF5xSecurityManager &);
     const nRF5xSecurityManager& operator=(const nRF5xSecurityManager &);
 
+    /*
+     * Expose an interface that allows us to query the SoftDevice bond table
+     * and extract a whitelist.
+     */
     ble_error_t createWhitelistFromBondTable(ble_gap_whitelist_t &whitelistFromBondTable) const {
         return btle_createWhitelistFromBondTable(&whitelistFromBondTable);
     }
 
+    /*
+     * Given a BLE address and a IRK this function check whether the address
+     * can be generated from the IRK. To do so, this function uses the hash
+     * function and algorithm described in the Bluetooth low Energy
+     * Specification. Internally, Nordic SDK functions are used.
+     */
     bool matchAddressAndIrk(ble_gap_addr_t *address, ble_gap_irk_t *irk) const {
         return btle_matchAddressAndIrk(address, irk);
     }
+
+    /*
+     * Give nRF5xGap access to createWhitelistFromBondTable() and
+     * matchAddressAndIrk()
+     */
     friend class nRF5xGap;
 };