Improve shutdown to clear BLE API and not just SD #87
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
added 2 commits
December 11, 2015 18:19
The module is updated to comply with the changes to BLE API regarding correct shutdown functionality. The following changes are introduced to ble-nrf51822: * Calls to the old static function shutdown in Gap, GattClient, GattServer and SecurityManager are removed. * The cleanup function in Gap, GattClient, GattServer and SecurityManager is renamed to `reset()` and made public. * The static references inside nRF5xGap, nRF5xGattClient, nRF5xGattServer and nRF5xSecurityManager to objects of their own class are moved to nRF5xn. * The static getInstance accessors in nRF5xGap, nRF5xGattClient, nRF5xGattServer and nRF5xSecurityManager are removed and their functionality is moved to the implemented virtual accessors in nRF5xn i.e. getGap(), getGattClient, etc. * A static function Instance is added to nRF5xn class to make the transport object accessible across the module.
|
@rgrover @pan- I have made changes according to comments in this pull request. |
| /* Shutdown the BLE API and nRF51 glue code */ | ||
| if (gattServerInstance != NULL && | ||
| gattServerInstance->reset() != BLE_ERROR_NONE) { | ||
| return BLE_ERROR_INVALID_STATE; |
There was a problem hiding this comment.
Could you return the error code instead of BLE_ERROR_INVALID_STATE ?
|
@rgrover made changes to make |
|
@andresag01 I'm happy with this. Will wait for @pan- |
|
It's alright, I'm looking for the next PR including onShutdown |
pan-
added a commit
that referenced
this pull request
Dec 15, 2015
Improve shutdown to clear BLE API and not just SD
|
ble-nrf51822-2.2.7 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
nRF5xGattServer, nRF5xSecurityManager and nRF5xServiceDiscovery.
static member shutdown() exposed by the BLE API in Gap.h, SecurityManager.h,
GattClient.h and GattServer.h.
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.
the reference in Gap is pointed to this object.
The shutdown procedure is as follows:
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.
NOTE: This enhancement also requires changes to the ble module
@rgrover @pan- @LiyouZhou