GapEvents.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef __GAP_EVENTS_H__
00018 #define __GAP_EVENTS_H__
00019 
00020 #include "blecommon.h"
00021 
00022 /**************************************************************************/
00023 /*!
00024     \brief
00025     The base class used to abstract away the callback events that can be
00026     triggered with the GAP.
00027 */
00028 /**************************************************************************/
00029 class GapEvents
00030 {
00031 public:
00032     /******************************************************************/
00033     /*!
00034         \brief
00035         Identifies GAP events generated by the radio HW when an event
00036         callback occurs.
00037     */
00038     /******************************************************************/
00039     typedef enum gapEvent_e {
00040         GAP_EVENT_TIMEOUT      = 1, /**< Advertising timed out before a connection could be established. */
00041         GAP_EVENT_CONNECTED    = 2, /**< A connection was established with a central device. */
00042         GAP_EVENT_DISCONNECTED = 3  /**< A connection was closed or lost with a central device. */
00043     } gapEvent_t;
00044 };
00045 
00046 #endif // ifndef __GAP_EVENTS_H__