Austin Blackstone / BLE_API

Fixes to BLE_API for mbedOS Alpha1 release. Mostly relating to doxygen fixes.

Fork of BLE_API by Bluetooth Low Energy

public/GapEvents.h@116:ca826083980e, 2014-09-02 (annotated)

Committer:
Rohit Grover
Date:
Tue Sep 02 15:09:46 2014 +0100
Revision:
116:ca826083980e
Parent:
106:a20be740075d
Child:
126:fdebe4d5d62f
Release 0.1.0

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



Mostly API changes.



Features

~~~~~~~~



- onConnection() callback now receives connection-parameters applicable to the

  new connection.



- onDataSent() callback now receives a count parameter containing the number of

  times notifications were sent out since the last callback.



- A 'reason' parameter has been added to Gap::disconnect() to indicate the

  reason for disconnection; and also to the onDisconnection callback to

  receive a reason from the remote host.



Bugfixes

~~~~~~~~



- onDataWritten() callback now receives an additional parameter

  (GattServer::WriteEventCallback_t) encapsulating the update. This avoids

  having to re-fetch the updated characteristic's value attribute. It also

  fixes a bug where multiple updates to the characteristic's value-attribute

  could get clobbered if they occurred in quick succession before the

  callbacks could be processed.

Who changed what in which revision?

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