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 #include "mbed.h"
00022 
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 /**************************************************************************/
00030 class GapEvents
00031 {
00032 public:
00033     /******************************************************************/
00034     /*!
00035         \brief
00036         Identifies GAP events generated by the radio HW when an event
00037         callback occurs
00038     */
00039     /******************************************************************/
00040     typedef enum gapEvent_e {
00041         GAP_EVENT_TIMEOUT      = 1,                 /**< Advertising timed out
00042                                                      *before a connection was
00043                                                      *established */
00044         GAP_EVENT_CONNECTED    = 2,                 /**< A connection was
00045                                                      *established with a
00046                                                      *central device */
00047         GAP_EVENT_DISCONNECTED = 3                  /**< A connection was
00048                                                      *closed or lost with a
00049                                                      *central device */
00050     } gapEvent_t;
00051 
00052     /******************************************************************/
00053     /*!
00054         \brief
00055         Advertising timed out before a connection was established
00056     */
00057     /******************************************************************/
00058     virtual void onTimeout(void) {
00059     }
00060 
00061     /******************************************************************/
00062     /*!
00063         \brief
00064         A connection was established with a central device
00065     */
00066     /******************************************************************/
00067     virtual void onConnected(void) {
00068     }
00069 
00070     /******************************************************************/
00071     /*!
00072         \brief
00073         A connection was closed or lost with a central device
00074     */
00075     /******************************************************************/
00076     virtual void onDisconnected(void) {
00077     }
00078 };
00079 
00080 #endif // ifndef __GAP_EVENTS_H__