Rob Kluin / nRF51822

config changes

Fork of nRF51822 by Nordic Semiconductor

source/nRF5xSecurityManager.cpp@561:613dbbdeed27, 2016-01-11 (annotated)

Committer:
vcoubard
Date:
Mon Jan 11 10:19:15 2016 +0000
Revision:
561:613dbbdeed27
Parent:
456:da0323feba9b
Child:
563:9c4b96f7be8d
Synchronized with git rev 7bf81e7e

Author: Andres Amaya Garcia

Improve shutdown to clear BLE API and not just SD



Improve the shutdown functionality, such that a call to ble.shutdown() from

the user application clears the API and nRF5x state and NOT only the

SoftDevice. To achieve this the following changes are introduced:



* Add a protected member cleanup() to nRF5xGap, nRF5xGattClient,

nRF5xGattServer, nRF5xSecurityManager and nRF5xServiceDiscovery.

* Modify the shutdown() implementation in nRF5xn such that it also calls the

static member shutdown() exposed by the BLE API in Gap.h, SecurityManager.h,

GattClient.h and GattServer.h.

* Modify nRF5xGattClient, nRF5xGattServer and nRF5xSecurityManager

classes so that they dynamically create their respective objects only if

needed. Previously the GattClient, GattServer and SecurityManager objects were

declared as static, which means that they were always present even though they

were not always needed. This increases memory consumption unnecessarily.

Furthermore, pointers to the object instances are stored in static members of

the classes as specified by the BLE API base classes. This ensures that

calls to shutdown do not require calls to getInstance() functions that would

otherwise result in undesired memory allocations.

* nRF5xGap object is always needed, so this remains allocated statically. But

the reference in Gap is pointed to this object.



The shutdown procedure is as follows:



1. The user calls ble.shutdown() which executes the code in nRF5xn::shutdown()

1. The SoftDevice is shutdown

1. The static members of Gap.h, SecurityManager.h, GattClient.h and

GattServer.h are called to clean up their own state.



If at any point an error occur during the last step, BLE_ERROR_INVALID_STATE is

returned.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vcoubard 561:613dbbdeed27 1 /* mbed Microcontroller Library
vcoubard 561:613dbbdeed27 2 * Copyright (c) 2006-2013 ARM Limited
vcoubard 561:613dbbdeed27 3 *
vcoubard 561:613dbbdeed27 4 * Licensed under the Apache License, Version 2.0 (the "License");
vcoubard 561:613dbbdeed27 5 * you may not use this file except in compliance with the License.
vcoubard 561:613dbbdeed27 6 * You may obtain a copy of the License at
vcoubard 561:613dbbdeed27 7 *
vcoubard 561:613dbbdeed27 8 * http://www.apache.org/licenses/LICENSE-2.0
vcoubard 561:613dbbdeed27 9 *
vcoubard 561:613dbbdeed27 10 * Unless required by applicable law or agreed to in writing, software
vcoubard 561:613dbbdeed27 11 * distributed under the License is distributed on an "AS IS" BASIS,
vcoubard 561:613dbbdeed27 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vcoubard 561:613dbbdeed27 13 * See the License for the specific language governing permissions and
vcoubard 561:613dbbdeed27 14 * limitations under the License.
vcoubard 561:613dbbdeed27 15 */
vcoubard 561:613dbbdeed27 16
vcoubard 561:613dbbdeed27 17 #include "nRF5xSecurityManager.h"
vcoubard 561:613dbbdeed27 18
vcoubard 561:613dbbdeed27 19 nRF5xSecurityManager &nRF5xSecurityManager::getInstance(void) {
vcoubard 561:613dbbdeed27 20 if (securityManagerInstance == NULL) {
vcoubard 561:613dbbdeed27 21 securityManagerInstance = new nRF5xSecurityManager();
vcoubard 561:613dbbdeed27 22 }
vcoubard 561:613dbbdeed27 23 return (nRF5xSecurityManager &) *securityManagerInstance;
rgrover1 388:db85a09c27ef 24 }