erkin yucel / mbed-os

mbed os with nrf51 internal bandgap enabled to read battery level

Dependents:   BLE_file_test BLE_Blink ExternalEncoder

features/FEATURE_BLE/ble/BLEInstanceBase.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /* mbed Microcontroller Library
elessair 0:f269e3021894 2 * Copyright (c) 2006-2013 ARM Limited
elessair 0:f269e3021894 3 *
elessair 0:f269e3021894 4 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:f269e3021894 5 * you may not use this file except in compliance with the License.
elessair 0:f269e3021894 6 * You may obtain a copy of the License at
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:f269e3021894 9 *
elessair 0:f269e3021894 10 * Unless required by applicable law or agreed to in writing, software
elessair 0:f269e3021894 11 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:f269e3021894 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:f269e3021894 13 * See the License for the specific language governing permissions and
elessair 0:f269e3021894 14 * limitations under the License.
elessair 0:f269e3021894 15 */
elessair 0:f269e3021894 16
elessair 0:f269e3021894 17 #ifndef __BLE_DEVICE_INSTANCE_BASE__
elessair 0:f269e3021894 18 #define __BLE_DEVICE_INSTANCE_BASE__
elessair 0:f269e3021894 19
elessair 0:f269e3021894 20 #include "Gap.h"
elessair 0:f269e3021894 21 #include "ble/SecurityManager.h"
elessair 0:f269e3021894 22 #include "ble/BLE.h"
elessair 0:f269e3021894 23
elessair 0:f269e3021894 24 /* Forward declarations. */
elessair 0:f269e3021894 25 class GattServer;
elessair 0:f269e3021894 26 class GattClient;
elessair 0:f269e3021894 27
elessair 0:f269e3021894 28 /**
elessair 0:f269e3021894 29 * The interface for the transport object to be created by the target library's
elessair 0:f269e3021894 30 * createBLEInstance().
elessair 0:f269e3021894 31 *
elessair 0:f269e3021894 32 * @note This class is part of the interface of BLE API with the implementation;
elessair 0:f269e3021894 33 * therefore, it is meant to be used only by porters rather than normal
elessair 0:f269e3021894 34 * BLE API users.
elessair 0:f269e3021894 35 */
elessair 0:f269e3021894 36 class BLEInstanceBase
elessair 0:f269e3021894 37 {
elessair 0:f269e3021894 38 public:
elessair 0:f269e3021894 39 BLEInstanceBase() {}
elessair 0:f269e3021894 40
elessair 0:f269e3021894 41 /**
elessair 0:f269e3021894 42 * Virtual destructor of the interface.
elessair 0:f269e3021894 43 */
elessair 0:f269e3021894 44 virtual ~BLEInstanceBase();
elessair 0:f269e3021894 45
elessair 0:f269e3021894 46 /**
elessair 0:f269e3021894 47 * Initialize the underlying BLE stack. This should be called before
elessair 0:f269e3021894 48 * anything else in the BLE API.
elessair 0:f269e3021894 49 *
elessair 0:f269e3021894 50 * @param[in] instanceID
elessair 0:f269e3021894 51 * The ID of the instance to initialize.
elessair 0:f269e3021894 52 * @param[in] initCallback
elessair 0:f269e3021894 53 * A callback for when initialization completes for a BLE
elessair 0:f269e3021894 54 * instance. This is an optional parameter set to NULL when not
elessair 0:f269e3021894 55 * supplied.
elessair 0:f269e3021894 56 *
elessair 0:f269e3021894 57 * @return BLE_ERROR_NONE if the initialization procedure was started
elessair 0:f269e3021894 58 * successfully.
elessair 0:f269e3021894 59 */
elessair 0:f269e3021894 60 virtual ble_error_t init(BLE::InstanceID_t instanceID,
elessair 0:f269e3021894 61 FunctionPointerWithContext<BLE::InitializationCompleteCallbackContext *> initCallback) = 0;
elessair 0:f269e3021894 62
elessair 0:f269e3021894 63 /**
elessair 0:f269e3021894 64 * Check whether the underlying stack has already been initialized,
elessair 0:f269e3021894 65 * possible with a call to init().
elessair 0:f269e3021894 66 *
elessair 0:f269e3021894 67 * @return true if the initialization has completed for the underlying BLE
elessair 0:f269e3021894 68 * stack.
elessair 0:f269e3021894 69 */
elessair 0:f269e3021894 70 virtual bool hasInitialized(void) const = 0;
elessair 0:f269e3021894 71
elessair 0:f269e3021894 72 /**
elessair 0:f269e3021894 73 * Shutdown the underlying BLE stack. This includes purging the stack of
elessair 0:f269e3021894 74 * GATT and GAP state and clearing all state from other BLE components
elessair 0:f269e3021894 75 * such as the SecurityManager. init() must be called afterwards to
elessair 0:f269e3021894 76 * re-instantiate services and GAP state.
elessair 0:f269e3021894 77 *
elessair 0:f269e3021894 78 * @return BLE_ERROR_NONE if the underlying stack and all other services of
elessair 0:f269e3021894 79 * the BLE API were shutdown correctly.
elessair 0:f269e3021894 80 */
elessair 0:f269e3021894 81 virtual ble_error_t shutdown(void) = 0;
elessair 0:f269e3021894 82
elessair 0:f269e3021894 83 /**
elessair 0:f269e3021894 84 * Fetches a string representation of the underlying BLE stack's version.
elessair 0:f269e3021894 85 *
elessair 0:f269e3021894 86 * @return A pointer to the string representation of the underlying
elessair 0:f269e3021894 87 * BLE stack's version.
elessair 0:f269e3021894 88 */
elessair 0:f269e3021894 89 virtual const char * getVersion(void) = 0;
elessair 0:f269e3021894 90
elessair 0:f269e3021894 91 /**
elessair 0:f269e3021894 92 * Accessor to Gap. This function is used by BLE::gap().
elessair 0:f269e3021894 93 *
elessair 0:f269e3021894 94 * @return A reference to a Gap object associated to this BLE instance.
elessair 0:f269e3021894 95 */
elessair 0:f269e3021894 96 virtual Gap& getGap() = 0;
elessair 0:f269e3021894 97
elessair 0:f269e3021894 98 /**
elessair 0:f269e3021894 99 * A const alternative to getGap().
elessair 0:f269e3021894 100 *
elessair 0:f269e3021894 101 * @return A const reference to a Gap object associated to this BLE instance.
elessair 0:f269e3021894 102 */
elessair 0:f269e3021894 103 virtual const Gap& getGap() const = 0;
elessair 0:f269e3021894 104
elessair 0:f269e3021894 105 /**
elessair 0:f269e3021894 106 * Accessor to GattServer. This function is used by BLE::gattServer().
elessair 0:f269e3021894 107 *
elessair 0:f269e3021894 108 * @return A reference to a GattServer object associated to this BLE instance.
elessair 0:f269e3021894 109 */
elessair 0:f269e3021894 110 virtual GattServer& getGattServer() = 0;
elessair 0:f269e3021894 111
elessair 0:f269e3021894 112 /**
elessair 0:f269e3021894 113 * A const alternative to getGattServer().
elessair 0:f269e3021894 114 *
elessair 0:f269e3021894 115 * @return A const reference to a GattServer object associated to this BLE instance.
elessair 0:f269e3021894 116 */
elessair 0:f269e3021894 117 virtual const GattServer& getGattServer() const = 0;
elessair 0:f269e3021894 118
elessair 0:f269e3021894 119 /**
elessair 0:f269e3021894 120 * Accessors to GattClient. This function is used by BLE::gattClient().
elessair 0:f269e3021894 121 *
elessair 0:f269e3021894 122 * @return A reference to a GattClient object associated to this BLE instance.
elessair 0:f269e3021894 123 */
elessair 0:f269e3021894 124 virtual GattClient& getGattClient() = 0;
elessair 0:f269e3021894 125
elessair 0:f269e3021894 126 /**
elessair 0:f269e3021894 127 * Accessors to SecurityManager. This function is used by BLE::securityManager().
elessair 0:f269e3021894 128 *
elessair 0:f269e3021894 129 * @return A reference to a SecurityManager object associated to this BLE instance.
elessair 0:f269e3021894 130 */
elessair 0:f269e3021894 131 virtual SecurityManager& getSecurityManager() = 0;
elessair 0:f269e3021894 132
elessair 0:f269e3021894 133 /**
elessair 0:f269e3021894 134 * A const alternative to getSecurityManager().
elessair 0:f269e3021894 135 *
elessair 0:f269e3021894 136 * @return A const reference to a SecurityManager object associated to this BLE instance.
elessair 0:f269e3021894 137 */
elessair 0:f269e3021894 138 virtual const SecurityManager& getSecurityManager() const = 0;
elessair 0:f269e3021894 139
elessair 0:f269e3021894 140 /**
elessair 0:f269e3021894 141 * Yield control to the BLE stack or to other tasks waiting for events.
elessair 0:f269e3021894 142 * refer to BLE::waitForEvent().
elessair 0:f269e3021894 143 */
elessair 0:f269e3021894 144 virtual void waitForEvent(void) = 0;
elessair 0:f269e3021894 145
elessair 0:f269e3021894 146 /**
elessair 0:f269e3021894 147 * Process ALL pending events living in the BLE stack .
elessair 0:f269e3021894 148 * Return once all events have been consumed.
elessair 0:f269e3021894 149 */
elessair 0:f269e3021894 150 virtual void processEvents() = 0;
elessair 0:f269e3021894 151
elessair 0:f269e3021894 152 /**
elessair 0:f269e3021894 153 * This function allow the BLE stack to signal that their is work to do and
elessair 0:f269e3021894 154 * event processing should be done (BLE::processEvent()).
elessair 0:f269e3021894 155 * @param id: The ID of the BLE instance which does have events to process.
elessair 0:f269e3021894 156 */
elessair 0:f269e3021894 157 void signalEventsToProcess(BLE::InstanceID_t id);
elessair 0:f269e3021894 158
elessair 0:f269e3021894 159 private:
elessair 0:f269e3021894 160 // this class is not a value type.
elessair 0:f269e3021894 161 // prohibit copy construction and copy assignement
elessair 0:f269e3021894 162 BLEInstanceBase(const BLEInstanceBase&);
elessair 0:f269e3021894 163 BLEInstanceBase& operator=(const BLEInstanceBase&);
elessair 0:f269e3021894 164 };
elessair 0:f269e3021894 165
elessair 0:f269e3021894 166 /**
elessair 0:f269e3021894 167 * BLE uses composition to hide an interface object encapsulating the
elessair 0:f269e3021894 168 * backend transport.
elessair 0:f269e3021894 169 *
elessair 0:f269e3021894 170 * The following API is used to create the singleton interface object. An
elessair 0:f269e3021894 171 * implementation for this function must be provided by the device-specific
elessair 0:f269e3021894 172 * library, otherwise there will be a linker error.
elessair 0:f269e3021894 173 */
elessair 0:f269e3021894 174 extern BLEInstanceBase *createBLEInstance(void);
elessair 0:f269e3021894 175
elessair 0:f269e3021894 176 #endif // ifndef __BLE_DEVICE_INSTANCE_BASE__