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@667:875aecb84719, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:53:01 2015 +0100
Revision:
667:875aecb84719
Parent:
662:25a8bce7f2e5
Child:
669:7179b4a5aa7d
Synchronized with git rev 43177a02

Author: Rohit Grover

remove un-necessary comments in GattClient.h

Who changed what in which revision?

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