Lancaster University / BLE_API

Lancaster University's fork of the mbed BLE API. Lives on github, https://github.com/lancaster-university/BLE_API

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

Fork of BLE_API by Bluetooth Low Energy

ble/BLEInstanceBase.h@890:f3144091ae19, 2015-11-26 (annotated)

Committer:
rgrover1
Date:
Thu Nov 26 12:52:00 2015 +0000
Revision:
890:f3144091ae19
Parent:
886:0a45c67b2301
Child:
892:9e00f683e927
Synchronized with git rev 216f73bc

Author: Irit Arkin

New version



Based on the main repo's master version, with edits to the API.

Who changed what in which revision?

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