Michael Galis
No changes
Fork of
nRF51822
by 
Nordic Semiconductor
Diff: source/nRF5xn.h
- Revision:
- 565:cf03471a4ec4
- Parent:
- 463:b869f947a37a
- Child:
- 566:e425ad9e5d6e
diff -r 77d4fcde8f2a -r cf03471a4ec4 source/nRF5xn.h
--- a/source/nRF5xn.h Mon Jan 11 10:19:17 2016 +0000
+++ b/source/nRF5xn.h Mon Jan 11 10:19:18 2016 +0000
@@ -1,72 +1,193 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef __NRF51822_H__
-#define __NRF51822_H__
-
-#include "ble/BLE.h"
-#include "ble/blecommon.h"
-#include "ble/BLEInstanceBase.h"
-
-#include "nRF5xGap.h"
-#include "nRF5xGattServer.h"
-#include "nRF5xGattClient.h"
-#include "nRF5xSecurityManager.h"
-
-#include "btle.h"
-
-class nRF5xn : public BLEInstanceBase
-{
-public:
- nRF5xn(void);
- virtual ~nRF5xn(void);
-
- virtual ble_error_t init(BLE::InstanceID_t instanceID, FunctionPointerWithContext<BLE::InitializationCompleteCallbackContext *> callback);
- virtual bool hasInitialized(void) const {
- return initialized;
- }
- virtual ble_error_t shutdown(void);
- virtual const char *getVersion(void);
-
- virtual Gap &getGap() {
- return nRF5xGap::getInstance();
- };
- virtual const Gap &getGap() const {
- return nRF5xGap::getInstance();
- };
- virtual GattServer &getGattServer() {
- return nRF5xGattServer::getInstance();
- };
- virtual const GattServer &getGattServer() const {
- return nRF5xGattServer::getInstance();
- };
- virtual GattClient &getGattClient() {
- return nRF5xGattClient::getInstance();
- }
- virtual const SecurityManager &getSecurityManager() const {
- return nRF5xSecurityManager::getInstance();
- }
- virtual SecurityManager &getSecurityManager() {
- return nRF5xSecurityManager::getInstance();
- }
- virtual void waitForEvent(void);
-
-private:
- bool initialized;
- BLE::InstanceID_t instanceID;
-};
-
+/* mbed Microcontroller Library
+ * Copyright (c) 2006-2013 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef __NRF51822_H__
+#define __NRF51822_H__
+
+#include "ble/BLE.h"
+#include "ble/blecommon.h"
+#include "ble/BLEInstanceBase.h"
+
+#include "nRF5xGap.h"
+#include "nRF5xGattServer.h"
+#include "nRF5xGattClient.h"
+#include "nRF5xSecurityManager.h"
+
+#include "btle.h"
+
+class nRF5xn : public BLEInstanceBase
+{
+public:
+ nRF5xn(void);
+ virtual ~nRF5xn(void);
+
+ virtual ble_error_t init(BLE::InstanceID_t instanceID, FunctionPointerWithContext<BLE::InitializationCompleteCallbackContext *> callback);
+ virtual bool hasInitialized(void) const {
+ return initialized;
+ }
+ virtual ble_error_t shutdown(void);
+ virtual const char *getVersion(void);
+
+ /**
+ * Accessors to GAP. This function checks whether gapInstance points to an
+ * object. If if does not, then the gapInstance is updated to
+ * &_getInstance before returning.
+ *
+ * @return A reference to GattServer.
+ *
+ * @note Unlike the GattClient, GattServer and SecurityManager, Gap is
+ * always needed in a BLE application. Therefore it is allocated
+ * statically.
+ */
+ virtual Gap &getGap() {
+ if (gapInstance == NULL) {
+ gapInstance = &_gapInstance;
+ }
+ return *gapInstance;
+ };
+
+ /**
+ * Accessors to GATT Server. This function checks whether a GattServer
+ * object was previously instantiated. If such object does not exist, then
+ * it is created before returning.
+ *
+ * @return A reference to GattServer.
+ */
+ virtual GattServer &getGattServer() {
+ if (gattServerInstance == NULL) {
+ gattServerInstance = new nRF5xGattServer();
+ }
+ return *gattServerInstance;
+ };
+
+ /**
+ * Accessors to GATT Client. This function checks whether a GattClient
+ * object was previously instantiated. If such object does not exist, then
+ * it is created before returning.
+ *
+ * @return A reference to GattClient.
+ */
+ virtual GattClient &getGattClient() {
+ if (gattClientInstance == NULL) {
+ gattClientInstance = new nRF5xGattClient();
+ }
+ return *gattClientInstance;
+ }
+
+ /**
+ * Accessors to Security Manager. This function checks whether a SecurityManager
+ * object was previously instantiated. If such object does not exist, then
+ * it is created before returning.
+ *
+ * @return A reference to GattServer.
+ */
+ virtual SecurityManager &getSecurityManager() {
+ if (securityManagerInstance == NULL) {
+ securityManagerInstance = new nRF5xSecurityManager();
+ }
+ return *securityManagerInstance;
+ }
+
+ /**
+ * Accessors to GAP. This function checks whether gapInstance points to an
+ * object. If if does not, then the gapInstance is updated to
+ * &_getInstance before returning.
+ *
+ * @return A const reference to GattServer.
+ *
+ * @note Unlike the GattClient, GattServer and SecurityManager, Gap is
+ * always needed in a BLE application. Therefore it is allocated
+ * statically.
+ *
+ * @note The accessor is able to modify the object's state because the
+ * internal pointer has been declared mutable.
+ */
+ virtual const Gap &getGap() const {
+ if (gapInstance == NULL) {
+ gapInstance = &_gapInstance;
+ }
+ return *gapInstance;
+ };
+
+ /**
+ * Accessors to GATT Server. This function checks whether a GattServer
+ * object was previously instantiated. If such object does not exist, then
+ * it is created before returning.
+ *
+ * @return A const reference to GattServer.
+ *
+ * @note The accessor is able to modify the object's state because the
+ * internal pointer has been declared mutable.
+ */
+ virtual const GattServer &getGattServer() const {
+ if (gattServerInstance == NULL) {
+ gattServerInstance = new nRF5xGattServer();
+ }
+ return *gattServerInstance;
+ };
+
+ /**
+ * Accessors to Security Manager. This function checks whether a SecurityManager
+ * object was previously instantiated. If such object does not exist, then
+ * it is created before returning.
+ *
+ * @return A const reference to GattServer.
+ *
+ * @note The accessor is able to modify the object's state because the
+ * internal pointer has been declared mutable.
+ */
+ virtual const SecurityManager &getSecurityManager() const {
+ if (securityManagerInstance == NULL) {
+ securityManagerInstance = new nRF5xSecurityManager();
+ }
+ return *securityManagerInstance;
+ }
+
+ virtual void waitForEvent(void);
+
+public:
+ static nRF5xn& Instance(BLE::InstanceID_t instanceId);
+
+private:
+ bool initialized;
+ BLE::InstanceID_t instanceID;
+
+private:
+ static nRF5xGap _gapInstance; /**< Gap instance whose reference is returned from a call to
+ * getGap(). Unlike the GattClient, GattServer and
+ * SecurityManager, Gap is always needed in a BLE application.
+ * Therefore it is allocated statically. */
+
+private:
+ mutable nRF5xGap *gapInstance; /**< Pointer to the Gap object instance.
+ * If NULL, then Gap has not been initialized.
+ * The pointer has been declared as 'mutable' so that
+ * it can be assigned inside a 'const' function. */
+ mutable nRF5xGattServer *gattServerInstance; /**< Pointer to the GattServer object instance.
+ * If NULL, then GattServer has not been initialized.
+ * The pointer has been declared as 'mutable' so that
+ * it can be assigned inside a 'const' function. */
+ mutable nRF5xGattClient *gattClientInstance; /**< Pointer to the GattClient object instance.
+ * If NULL, then GattClient has not been initialized.
+ * The pointer has been declared as 'mutable' so that
+ * it can be assigned inside a 'const' function. */
+ mutable nRF5xSecurityManager *securityManagerInstance; /**< Pointer to the SecurityManager object instance.
+ * If NULL, then SecurityManager has not been initialized.
+ * The pointer has been declared as 'mutable' so that
+ * it can be assigned inside a 'const' function. */
+};
+
#endif
\ No newline at end of file