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

Committer:
rgrover1
Date:
2015-11-26
Revision:
907:f9a79127973a
Parent:
906:8ddab3271c2f
Child:
912:f728aa46e7df

File content as of revision 907:f9a79127973a:

/* mbed Microcontroller Library
 * Copyright (c) 2006-2013 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __BLE_DEVICE_INSTANCE_BASE__
#define __BLE_DEVICE_INSTANCE_BASE__

#include "Gap.h"
#include "ble/SecurityManager.h"
#include "ble/BLE.h"

/* Forward declarations. */
class GattServer;
class GattClient;

/**
 *  The interface for the transport object to be created by the target library's
 *  createBLEInstance().
 */
class BLEInstanceBase
{
public:
    virtual ble_error_t            init(BLE::InstanceID_t instanceID,
                                        FunctionPointerWithContext<BLE::InitializationCompleteCallbackContext *> initCallback) = 0;
    virtual bool                   hasInitialized(void) const = 0;
    virtual ble_error_t            shutdown(void)             = 0;
    virtual const char *           getVersion(void)           = 0;
    virtual Gap&                   getGap()                   = 0;
    virtual const Gap&             getGap() const             = 0;
    virtual GattServer&            getGattServer()            = 0;
    virtual const GattServer&      getGattServer() const      = 0;
    virtual GattClient&            getGattClient()            = 0;
    virtual SecurityManager&       getSecurityManager()       = 0;
    virtual const SecurityManager& getSecurityManager() const = 0;
    virtual void                   waitForEvent(void)         = 0;
};

/**
 * BLE uses composition to hide an interface object encapsulating the
 * backend transport.
 *
 * The following API is used to create the singleton interface object. An
 * implementation for this function must be provided by the device-specific
 * library, otherwise there will be a linker error.
 */
extern BLEInstanceBase *createBLEInstance(void);

#endif // ifndef __BLE_DEVICE_INSTANCE_BASE__