ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

BLE: Deprecate GapEvent 

This class and its components are not used by BLE API and never been used in the
last two years.

This patch deprecate all the components in GapEvent.h and exclude its definitions
from the documentation process.
pull/5410/head
Vincent Coubard 2017-10-31 16:39:24 +00:00
parent 20d93bf78d
commit 65bb642c81
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
features/FEATURE_BLE/ble/GapEvents.h
View File

@ -14,28 +14,30 @@
* limitations under the License.
*/
#ifndef __GAP_EVENTS_H__
#define __GAP_EVENTS_H__
#ifndef MBED_GAP_EVENTS_H__
#define MBED_GAP_EVENTS_H__
#include "blecommon.h"
/**************************************************************************/
/// @cond 0
/*!
\brief
The base class used to abstract away the callback events that can be
triggered with the GAP.
@deprecated Do not use; it is not used by BLE API.
*/
/**************************************************************************/
class GapEvents
{
public:
/******************************************************************/
/*!
\brief
Identifies GAP events generated by the radio HW when an event
callback occurs.
@deprecated Do not use; it is not used by BLE API.
*/
/******************************************************************/
typedef enum gapEvent_e {
GAP_EVENT_TIMEOUT = 1, /**< Advertising timed out before a connection could be established. */
GAP_EVENT_CONNECTED = 2, /**< A connection was established with a central device. */
@ -43,4 +45,6 @@ public:
} gapEvent_t;
};
#endif // ifndef __GAP_EVENTS_H__
/// @endcond
#endif // ifndef MBED_GAP_EVENTS_H__