xiao sun / BLE_API

fork BLE_API to add update adv payload API

Fork of BLE_API by Bluetooth Low Energy

ble/GapEvents.h@716:11b41f651697, 2015-07-02 (annotated)

Committer:
rgrover1
Date:
Thu Jul 02 09:06:11 2015 +0100
Revision:
716:11b41f651697
Parent:
public/GapEvents.h@714:a6130aaa0fd9 
Synchronized with git rev d80fec88

Author: Rohit Grover

Release 0.4.0

=============



This is a major release which introduces the GATT Client functionality. It

also aligns BLE_API with builds using our new package manager: yotta

(https://github.com/armmbed/yotta).



Many APIs have seen some redesign. We encourage our users to pay attention to

the changes and migrate appropriately over time. We've also taken care to

ensure that existing code continues to work the same way. There's more

documentation in the form of comment headers for APIs to explain proper usage;

in many cases comment headers suggest alternative use of APIs.



Enhancements

~~~~~~~~~~~~



* Introduce GattClient. This includes functionality for service-discovery,

  connections, and attribute-reads and writes. You'll find a demo program for

  LEDBlinker on the mbed.org Bluetooth team page to use the new APIs. Some of

  the GATT client functionality hasn't been implemented yet, but the APIs have

  been added.



* Most APIs in the abstract base classes like Gap and GattServer return

  BLE_ERROR_NOT_IMPLEMENTED. Previously many APIs were pure-virtual, which did

  not permit partial ports to compile.



* We've added a new abstract base class for SecurityManager. All security

  related APIs have been moved into that.



* BLEDevice has been renamed as BLE. A deprecated alias for BLEDevice is

  available to support existing code.



* There has been a major cleanup of APIs under BLE. APIs have now been

  categorized as belonging to Gap, GattServer, GattClient, or SecurityManager.

  There are accessors to get references for Gap, GattServer, GattClient, and

  SecurityManager. A former call to ble.setAddress(...) is now expected to be

  achieved with ble.gap().setAddress(...).



* We've cleaned up our APIs, and this has resulted in dropping some APIs like

  BLE::reset().



* We've also dropped GattServer::initializeGattDatabase(). THis was added at

  some point to support controllers where a commit point was needed to

  indicate when the application had finished constructing the GATT database.

  This API would get called internally before Gap::startAdvertising(). We now

  expect the underlying port to do the equivalent of initializeGattDatabase()

  implicitly upon Gap::startAdvertising().



* The callback for BLE.onTimeout() now receives a TimeoutSource_t to indicate

  the cause of the timeout. This is perhaps the only breaking API change. We

  expect it to have very little disruptive effect.



* We've added a version of Gap::disconnect() which takes a connection handle.

  The previous API (which did not take a connection handle) has been

  deprecated; it will still work for situations where there's only a single

  active connection. We hold on to that API to allow existing code to migrate

  to the new API.



Bugfixes

~~~~~~~~



* None.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 710:b2e1a2660ec2 1 /* mbed Microcontroller Library
rgrover1 710:b2e1a2660ec2 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 710:b2e1a2660ec2 3 *
rgrover1 710:b2e1a2660ec2 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 710:b2e1a2660ec2 5 * you may not use this file except in compliance with the License.
rgrover1 710:b2e1a2660ec2 6 * You may obtain a copy of the License at
rgrover1 710:b2e1a2660ec2 7 *
rgrover1 710:b2e1a2660ec2 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 710:b2e1a2660ec2 9 *
rgrover1 710:b2e1a2660ec2 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 710:b2e1a2660ec2 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 710:b2e1a2660ec2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 710:b2e1a2660ec2 13 * See the License for the specific language governing permissions and
rgrover1 710:b2e1a2660ec2 14 * limitations under the License.
rgrover1 710:b2e1a2660ec2 15 */
rgrover1 710:b2e1a2660ec2 16
rgrover1 710:b2e1a2660ec2 17 #ifndef __GAP_EVENTS_H__
rgrover1 710:b2e1a2660ec2 18 #define __GAP_EVENTS_H__
rgrover1 710:b2e1a2660ec2 19
rgrover1 710:b2e1a2660ec2 20 #include "blecommon.h"
rgrover1 710:b2e1a2660ec2 21
rgrover1 710:b2e1a2660ec2 22 /**************************************************************************/
rgrover1 710:b2e1a2660ec2 23 /*!
rgrover1 710:b2e1a2660ec2 24 \brief
rgrover1 710:b2e1a2660ec2 25 The base class used to abstract away the callback events that can be
rgrover1 710:b2e1a2660ec2 26 triggered with the GAP.
rgrover1 710:b2e1a2660ec2 27 */
rgrover1 710:b2e1a2660ec2 28 /**************************************************************************/
rgrover1 710:b2e1a2660ec2 29 class GapEvents
rgrover1 710:b2e1a2660ec2 30 {
rgrover1 710:b2e1a2660ec2 31 public:
rgrover1 710:b2e1a2660ec2 32 /******************************************************************/
rgrover1 710:b2e1a2660ec2 33 /*!
rgrover1 710:b2e1a2660ec2 34 \brief
rgrover1 710:b2e1a2660ec2 35 Identifies GAP events generated by the radio HW when an event
rgrover1 710:b2e1a2660ec2 36 callback occurs
rgrover1 710:b2e1a2660ec2 37 */
rgrover1 710:b2e1a2660ec2 38 /******************************************************************/
rgrover1 710:b2e1a2660ec2 39 typedef enum gapEvent_e {
rgrover1 710:b2e1a2660ec2 40 GAP_EVENT_TIMEOUT = 1, /**< Advertising timed out before a connection was established */
rgrover1 710:b2e1a2660ec2 41 GAP_EVENT_CONNECTED = 2, /**< A connection was established with a central device */
rgrover1 710:b2e1a2660ec2 42 GAP_EVENT_DISCONNECTED = 3 /**< A connection was closed or lost with a central device */
rgrover1 710:b2e1a2660ec2 43 } gapEvent_t;
rgrover1 710:b2e1a2660ec2 44 };
rgrover1 710:b2e1a2660ec2 45
rgrover1 710:b2e1a2660ec2 46 #endif // ifndef __GAP_EVENTS_H__