Diff: public/SecurityManager.h

Revision:

560:ce6e36951457

Parent:

546:9fdf3d960d12

diff -r 1ee5106d3763 -r ce6e36951457 public/SecurityManager.h
--- a/public/SecurityManager.h	Fri Jun 19 15:52:11 2015 +0100
+++ b/public/SecurityManager.h	Fri Jun 19 15:52:11 2015 +0100
@@ -82,6 +82,9 @@
     typedef void (*LinkSecuredCallback_t)(Gap::Handle_t handle, SecurityMode_t securityMode);
     typedef void (*PasskeyDisplayCallback_t)(Gap::Handle_t handle, const Passkey_t passkey);
 
+    /*
+     * The following functions are meant to be overridden in the platform-specific sub-class.
+     */
 public:
     /**
      * Enable the BLE stack's Security Manager. The Security Manager implements
@@ -129,6 +132,7 @@
         return BLE_ERROR_NOT_IMPLEMENTED; /* default implementation; override this if security is supported. */
     }
 
+    /* Event callback handlers. */
 public:
     /**
      * To indicate that security procedure for link has started.
@@ -158,6 +162,7 @@
      */
     virtual void onPasskeyDisplay(PasskeyDisplayCallback_t callback) {passkeyDisplayCallback = callback;}
 
+    /* Entry points for the underlying stack to report events back to the user. */
 public:
     void processSecuritySetupInitiatedEvent(Gap::Handle_t handle, bool allowBonding, bool requireMITM, SecurityIOCapabilities_t iocaps) {
         if (securitySetupInitiatedCallback) {
@@ -199,7 +204,6 @@
         /* empty */
     }
 
-
 protected:
     SecuritySetupInitiatedCallback_t securitySetupInitiatedCallback;
     SecuritySetupCompletedCallback_t securitySetupCompletedCallback;