Oscar Ariza / BLE_API

BLE

Fork of BLE_API by Bluetooth Low Energy

ble/GapEvents.h@913:f728aa46e7df, 2015-11-26 (annotated)

Committer:
rgrover1
Date:
Thu Nov 26 12:52:03 2015 +0000
Revision:
913:f728aa46e7df
Parent:
908:f9a79127973a
Child:
914:690bea02c431
Synchronized with git rev 562aa49e

Author: Rohit Grover

delete an incorrect comment from the documentation in Gap.h

Who changed what in which revision?

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