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 MBED_GAP_EVENTS_H__
00018 #define MBED_GAP_EVENTS_H__
00019 
00020 #include "blecommon.h"
00021 
00022 /// @cond INVALID_SECTIONS
00023 
00024 /*!
00025     \brief
00026     The base class used to abstract away the callback events that can be
00027     triggered with the GAP.
00028 
00029     @deprecated Do not use; it is not used by BLE API.
00030 */
00031 class GapEvents
00032 {
00033 public:
00034     /*!
00035         \brief
00036         Identifies GAP events generated by the radio HW when an event
00037         callback occurs.
00038 
00039         @deprecated Do not use; it is not used by BLE API.
00040     */
00041     typedef enum gapEvent_e {
00042         GAP_EVENT_TIMEOUT      = 1, /**< Advertising timed out before a connection could be established. */
00043         GAP_EVENT_CONNECTED    = 2, /**< A connection was established with a central device. */
00044         GAP_EVENT_DISCONNECTED = 3  /**< A connection was closed or lost with a central device. */
00045     } gapEvent_t;
00046 };
00047 
00048 /// @endcond
00049 
00050 #endif // ifndef MBED_GAP_EVENTS_H__