Lancaster University / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   microbit-dal microbit-dal microbit-ble-open microbit-dal ... more

Fork of BLE_API by Bluetooth Low Energy

common/BLEDeviceInstanceBase.h@230:2c414d3240a8, 2014-12-03 (annotated)

Committer:
rgrover1
Date:
Wed Dec 03 14:38:40 2014 +0000
Revision:
230:2c414d3240a8
Parent:
111:189ff241dae1
Child:
305:71367f7cd078
Synchronized with git rev 7e9f9a05

Author: Rohit Grover

add API BLEDevice::shutdown() to purge the BLE stack of GATT and GAP state.

init() should be called before restoring state.



fixes #15.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rohit Grover 111:189ff241dae1 1 /* mbed Microcontroller Library
Rohit Grover 111:189ff241dae1 2 * Copyright (c) 2006-2013 ARM Limited
Rohit Grover 111:189ff241dae1 3 *
Rohit Grover 111:189ff241dae1 4 * Licensed under the Apache License, Version 2.0 (the "License");
Rohit Grover 111:189ff241dae1 5 * you may not use this file except in compliance with the License.
Rohit Grover 111:189ff241dae1 6 * You may obtain a copy of the License at
Rohit Grover 111:189ff241dae1 7 *
Rohit Grover 111:189ff241dae1 8 * http://www.apache.org/licenses/LICENSE-2.0
Rohit Grover 111:189ff241dae1 9 *
Rohit Grover 111:189ff241dae1 10 * Unless required by applicable law or agreed to in writing, software
Rohit Grover 111:189ff241dae1 11 * distributed under the License is distributed on an "AS IS" BASIS,
Rohit Grover 111:189ff241dae1 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Rohit Grover 111:189ff241dae1 13 * See the License for the specific language governing permissions and
Rohit Grover 111:189ff241dae1 14 * limitations under the License.
Rohit Grover 111:189ff241dae1 15 */
Rohit Grover 111:189ff241dae1 16
Rohit Grover 111:189ff241dae1 17 #ifndef __BLE_DEVICE_INSTANCE_BASE__
Rohit Grover 111:189ff241dae1 18 #define __BLE_DEVICE_INSTANCE_BASE__
Rohit Grover 111:189ff241dae1 19
Rohit Grover 111:189ff241dae1 20 /**
Rohit Grover 111:189ff241dae1 21 * The interface for the transport object to be created by the target library's
Rohit Grover 111:189ff241dae1 22 * createBLEDeviceInstance().
Rohit Grover 111:189ff241dae1 23 */
Rohit Grover 111:189ff241dae1 24 class BLEDeviceInstanceBase
Rohit Grover 111:189ff241dae1 25 {
Rohit Grover 111:189ff241dae1 26 public:
Rohit Grover 111:189ff241dae1 27 virtual const char *getVersion(void) = 0;
Rohit Grover 111:189ff241dae1 28 virtual Gap& getGap() = 0;
Rohit Grover 111:189ff241dae1 29 virtual GattServer& getGattServer() = 0;
Rohit Grover 111:189ff241dae1 30 virtual ble_error_t init(void) = 0;
rgrover1 230:2c414d3240a8 31 virtual ble_error_t shutdown(void) = 0;
Rohit Grover 111:189ff241dae1 32 virtual ble_error_t reset(void) = 0;
Rohit Grover 111:189ff241dae1 33 virtual ble_error_t setTxPower(int8_t txPower) = 0;
Rohit Grover 111:189ff241dae1 34 virtual void waitForEvent(void) = 0;
Rohit Grover 111:189ff241dae1 35 };
Rohit Grover 111:189ff241dae1 36
Rohit Grover 111:189ff241dae1 37 /**
Rohit Grover 111:189ff241dae1 38 * BLEDevice uses composition to hide an interface object encapsulating the
Rohit Grover 111:189ff241dae1 39 * backend transport.
Rohit Grover 111:189ff241dae1 40 *
Rohit Grover 111:189ff241dae1 41 * The following API is used to create the singleton interface object. An
Rohit Grover 111:189ff241dae1 42 * implementation for this function must be provided by the device-specific
Rohit Grover 111:189ff241dae1 43 * library, otherwise there will be a linker error.
Rohit Grover 111:189ff241dae1 44 */
Rohit Grover 111:189ff241dae1 45 extern BLEDeviceInstanceBase *createBLEDeviceInstance(void);
Rohit Grover 111:189ff241dae1 46
rgrover1 230:2c414d3240a8 47 #endif // ifndef __BLE_DEVICE_INSTANCE_BASE__