initial re-organization of BLE_API directory structure

This commit is contained in:
Rohit Grover 2014-07-23 15:09:23 +01:00
parent 227cf0ebf0
commit 9c8f69c78c
18 changed files with 51 additions and 31 deletions

View file

@ -0,0 +1,44 @@
/* 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__
/**
* The interface for the transport object to be created by the target library's
* createBLEDeviceInstance().
*/
class BLEDeviceInstanceBase
{
public:
virtual Gap& getGap() = 0;
virtual GattServer& getGattServer() = 0;
virtual ble_error_t init(void) = 0;
virtual ble_error_t reset(void) = 0;
virtual void waitForEvent(void) = 0;
};
/**
* BLEDevice 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 BLEDeviceInstanceBase *createBLEDeviceInstance(void);
#endif // ifndef __BLE_DEVICE_INSTANCE_BASE__

1
common/readme.txt Normal file
View file

@ -0,0 +1 @@
These files are common to all implementations of the BLE_API.

View file

@ -14,25 +14,14 @@
* limitations under the License.
*/
#ifndef __BLE_DEVICE__
#define __BLE_DEVICE__
#include "mbed.h"
#include "blecommon.h"
#include "hw/Gap.h"
#include "hw/GattServer.h"
#include "Gap.h"
#include "GattServer.h"
#include "BLEDeviceInstanceBase.hpp"
class BLEDeviceInstanceBase; /* forward declaration */
/**
* BLEDevice 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 BLEDeviceInstanceBase *createBLEDeviceInstance(void);
#ifndef __BLE_DEVICE__
#define __BLE_DEVICE__
/**
* The base class used to abstract away BLE capable radio transceivers or SOCs,
@ -283,21 +272,6 @@ public:
ble_error_t startAdvertising(const GapAdvertisingParams &advParams);
};
/**
* The interface for the transport object to be created by the target library's
* createBLEDeviceInstance().
*/
class BLEDeviceInstanceBase
{
public:
virtual Gap& getGap() = 0;
virtual GattServer& getGattServer() = 0;
virtual ble_error_t init(void) = 0;
virtual ble_error_t reset(void) = 0;
virtual void waitForEvent(void) = 0;
};
/* BLEDevice methods. Most of these simply forward the calls to the underlying
* transport.*/

1
public/readme.txt Normal file
View file

@ -0,0 +1 @@
The public API exposed through header files.