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@106:a20be740075d, 2014-07-23 (annotated)

Committer:
Rohit Grover
Date:
Wed Jul 23 15:09:23 2014 +0100
Revision:
106:a20be740075d
Child:
116:ca826083980e
initial re-organization of BLE_API directory structure

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 106:a20be740075d 41 GAP_EVENT_TIMEOUT = 1, /**< Advertising timed out
Rohit Grover 106:a20be740075d 42 *before a connection was
Rohit Grover 106:a20be740075d 43 *established */
Rohit Grover 106:a20be740075d 44 GAP_EVENT_CONNECTED = 2, /**< A connection was
Rohit Grover 106:a20be740075d 45 *established with a
Rohit Grover 106:a20be740075d 46 *central device */
Rohit Grover 106:a20be740075d 47 GAP_EVENT_DISCONNECTED = 3 /**< A connection was
Rohit Grover 106:a20be740075d 48 *closed or lost with a
Rohit Grover 106:a20be740075d 49 *central device */
Rohit Grover 106:a20be740075d 50 } gapEvent_t;
Rohit Grover 106:a20be740075d 51
Rohit Grover 106:a20be740075d 52 /******************************************************************/
Rohit Grover 106:a20be740075d 53 /*!
Rohit Grover 106:a20be740075d 54 \brief
Rohit Grover 106:a20be740075d 55 Advertising timed out before a connection was established
Rohit Grover 106:a20be740075d 56 */
Rohit Grover 106:a20be740075d 57 /******************************************************************/
Rohit Grover 106:a20be740075d 58 virtual void onTimeout(void) {
Rohit Grover 106:a20be740075d 59 }
Rohit Grover 106:a20be740075d 60
Rohit Grover 106:a20be740075d 61 /******************************************************************/
Rohit Grover 106:a20be740075d 62 /*!
Rohit Grover 106:a20be740075d 63 \brief
Rohit Grover 106:a20be740075d 64 A connection was established with a central device
Rohit Grover 106:a20be740075d 65 */
Rohit Grover 106:a20be740075d 66 /******************************************************************/
Rohit Grover 106:a20be740075d 67 virtual void onConnected(void) {
Rohit Grover 106:a20be740075d 68 }
Rohit Grover 106:a20be740075d 69
Rohit Grover 106:a20be740075d 70 /******************************************************************/
Rohit Grover 106:a20be740075d 71 /*!
Rohit Grover 106:a20be740075d 72 \brief
Rohit Grover 106:a20be740075d 73 A connection was closed or lost with a central device
Rohit Grover 106:a20be740075d 74 */
Rohit Grover 106:a20be740075d 75 /******************************************************************/
Rohit Grover 106:a20be740075d 76 virtual void onDisconnected(void) {
Rohit Grover 106:a20be740075d 77 }
Rohit Grover 106:a20be740075d 78 };
Rohit Grover 106:a20be740075d 79
Rohit Grover 106:a20be740075d 80 #endif // ifndef __GAP_EVENTS_H__