Wang Xinglu / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependencies:   nRF51822

Dependents:   LinkNode_LIS3DH

Fork of BLE_API by Bluetooth Low Energy

common/BLEDeviceInstanceBase.h@490:58a0313fffb5, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:02 2015 +0100
Revision:
490:58a0313fffb5
Parent:
489:eb4427171ae0
Child:
500:2625510739a6
Synchronized with git rev e106a951

Author: Rohit Grover

introduce abstract class for GattClient

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
rgrover1 489:eb4427171ae0 20 #include "Gap.h"
rgrover1 489:eb4427171ae0 21 #include "GattServer.h"
rgrover1 490:58a0313fffb5 22 #include "GattClient.h"
rgrover1 489:eb4427171ae0 23
Rohit Grover 111:189ff241dae1 24 /**
Rohit Grover 111:189ff241dae1 25 * The interface for the transport object to be created by the target library's
Rohit Grover 111:189ff241dae1 26 * createBLEDeviceInstance().
Rohit Grover 111:189ff241dae1 27 */
Rohit Grover 111:189ff241dae1 28 class BLEDeviceInstanceBase
Rohit Grover 111:189ff241dae1 29 {
Rohit Grover 111:189ff241dae1 30 public:
Rohit Grover 111:189ff241dae1 31 virtual const char *getVersion(void) = 0;
Rohit Grover 111:189ff241dae1 32 virtual Gap& getGap() = 0;
Rohit Grover 111:189ff241dae1 33 virtual GattServer& getGattServer() = 0;
rgrover1 490:58a0313fffb5 34 virtual GattClient& getGattClient() = 0;
rgrover1 490:58a0313fffb5 35
Rohit Grover 111:189ff241dae1 36 virtual ble_error_t init(void) = 0;
rgrover1 230:2c414d3240a8 37 virtual ble_error_t shutdown(void) = 0;
Rohit Grover 111:189ff241dae1 38 virtual ble_error_t reset(void) = 0;
rgrover1 357:d4bb5d2b837a 39 virtual ble_error_t initializeSecurity(bool enableBonding = true,
rgrover1 357:d4bb5d2b837a 40 bool requireMITM = true,
rgrover1 357:d4bb5d2b837a 41 Gap::SecurityIOCapabilities_t iocaps = Gap::IO_CAPS_NONE,
rgrover1 357:d4bb5d2b837a 42 const Gap::Passkey_t passkey = NULL) = 0;
Rohit Grover 111:189ff241dae1 43 virtual ble_error_t setTxPower(int8_t txPower) = 0;
rgrover1 305:71367f7cd078 44 virtual void getPermittedTxPowerValues(const int8_t **, size_t *) = 0;
Rohit Grover 111:189ff241dae1 45 virtual void waitForEvent(void) = 0;
Rohit Grover 111:189ff241dae1 46 };
Rohit Grover 111:189ff241dae1 47
Rohit Grover 111:189ff241dae1 48 /**
Rohit Grover 111:189ff241dae1 49 * BLEDevice uses composition to hide an interface object encapsulating the
Rohit Grover 111:189ff241dae1 50 * backend transport.
Rohit Grover 111:189ff241dae1 51 *
Rohit Grover 111:189ff241dae1 52 * The following API is used to create the singleton interface object. An
Rohit Grover 111:189ff241dae1 53 * implementation for this function must be provided by the device-specific
Rohit Grover 111:189ff241dae1 54 * library, otherwise there will be a linker error.
Rohit Grover 111:189ff241dae1 55 */
Rohit Grover 111:189ff241dae1 56 extern BLEDeviceInstanceBase *createBLEDeviceInstance(void);
Rohit Grover 111:189ff241dae1 57
rgrover1 230:2c414d3240a8 58 #endif // ifndef __BLE_DEVICE_INSTANCE_BASE__