Andrew Fox / 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.

Fork of BLE_API by Bluetooth Low Energy

common/BLEDeviceInstanceBase.h@670:5e4aecd9af5b, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:53:01 2015 +0100
Revision:
670:5e4aecd9af5b
Parent:
669:7179b4a5aa7d 
Synchronized with git rev 532535b1

Author: Rohit Grover

Merge branch 'gattClient' into develop

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 670:5e4aecd9af5b 20 #include "Gap.h"
rgrover1 670:5e4aecd9af5b 21
rgrover1 670:5e4aecd9af5b 22 /* forward declarations */
rgrover1 670:5e4aecd9af5b 23 class GattServer;
rgrover1 670:5e4aecd9af5b 24 class GattClient;
rgrover1 670:5e4aecd9af5b 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 669:7179b4a5aa7d 33 virtual ble_error_t init(void) = 0;
rgrover1 669:7179b4a5aa7d 34 virtual ble_error_t shutdown(void) = 0;
rgrover1 669:7179b4a5aa7d 35 virtual ble_error_t reset(void) = 0;
rgrover1 667:875aecb84719 36 virtual const char *getVersion(void) = 0;
rgrover1 667:875aecb84719 37 virtual Gap& getGap() = 0;
rgrover1 667:875aecb84719 38 virtual GattServer& getGattServer() = 0;
rgrover1 670:5e4aecd9af5b 39 virtual GattClient& getGattClient() = 0;
rgrover1 567:e4b38e43de7c 40 virtual ble_error_t initializeSecurity(bool enableBonding = true,
rgrover1 567:e4b38e43de7c 41 bool requireMITM = true,
rgrover1 567:e4b38e43de7c 42 Gap::SecurityIOCapabilities_t iocaps = Gap::IO_CAPS_NONE,
rgrover1 567:e4b38e43de7c 43 const Gap::Passkey_t passkey = NULL) = 0;
rgrover1 567:e4b38e43de7c 44 virtual void waitForEvent(void) = 0;
rgrover1 567:e4b38e43de7c 45 };
rgrover1 567:e4b38e43de7c 46
rgrover1 567:e4b38e43de7c 47 /**
rgrover1 567:e4b38e43de7c 48 * BLEDevice uses composition to hide an interface object encapsulating the
rgrover1 567:e4b38e43de7c 49 * backend transport.
rgrover1 567:e4b38e43de7c 50 *
rgrover1 567:e4b38e43de7c 51 * The following API is used to create the singleton interface object. An
rgrover1 567:e4b38e43de7c 52 * implementation for this function must be provided by the device-specific
rgrover1 567:e4b38e43de7c 53 * library, otherwise there will be a linker error.
rgrover1 567:e4b38e43de7c 54 */
rgrover1 567:e4b38e43de7c 55 extern BLEDeviceInstanceBase *createBLEDeviceInstance(void);
rgrover1 567:e4b38e43de7c 56
rgrover1 567:e4b38e43de7c 57 #endif // ifndef __BLE_DEVICE_INSTANCE_BASE__