Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of BLE_API by
Diff: GapAdvertisingParams.h
- Revision:
- 18:86fe1e247a54
- Parent:
- 14:6ea5d1012a64
- Child:
- 21:5442f7c70e71
diff -r 9eb2b6fbbda9 -r 86fe1e247a54 GapAdvertisingParams.h
--- a/GapAdvertisingParams.h Wed Dec 18 19:15:07 2013 +0000
+++ b/GapAdvertisingParams.h Wed Dec 18 19:39:19 2013 +0000
@@ -8,6 +8,29 @@
#define GAP_ADV_PARAMS_INTERVAL_MAX (0x1000)
#define GAP_ADV_PARAMS_TIMEOUT_MAX (0x3FFF)
+/**************************************************************************/
+/*!
+ \brief
+ This class provides a wrapper for the core advertising parameters,
+ including the advertising type (Connectable Undirected,
+ Non Connectable Undirected, etc.), as well as the advertising and
+ timeout intervals.
+
+ \par
+ See the following for more information on advertising types:
+
+ \li \c Bluetooth Core Specification 4.0 (Vol. 6), Part B, Section 2.3.1
+ \li \c Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 9.3
+
+ \par EXAMPLE
+
+ \code
+
+ // ToDo
+
+ \endcode
+*/
+/**************************************************************************/
class GapAdvertisingParams
{
public:
