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:
- 34:da2ea8cd6216
- Parent:
- 27:4a83843f04b0
- Child:
- 40:d405c9b1419d
diff -r 6d51a2c69442 -r da2ea8cd6216 GapAdvertisingParams.h
--- a/GapAdvertisingParams.h Thu Apr 03 01:45:33 2014 +0100
+++ b/GapAdvertisingParams.h Wed May 21 15:01:14 2014 +0100
@@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+
#ifndef __GAP_ADVERTISING_PARAMS_H__
#define __GAP_ADVERTISING_PARAMS_H__
@@ -34,22 +34,22 @@
\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:
+public:
/**************************************************************************/
/*!
\brief
@@ -58,32 +58,40 @@
\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
*/
/**************************************************************************/
enum AdvertisingType
{
- ADV_CONNECTABLE_UNDIRECTED, /**< Vol 3, Part C, Section 9.3.4 and Vol 6, Part B, Section 2.3.1.1 */
- ADV_CONNECTABLE_DIRECTED, /**< Vol 3, Part C, Section 9.3.3 and Vol 6, Part B, Section 2.3.1.2 */
- ADV_SCANNABLE_UNDIRECTED, /**< Include support for Scan Response payloads, see Vol 6, Part B, Section 2.3.1.4 */
- ADV_NON_CONNECTABLE_UNDIRECTED /**< Vol 3, Part C, Section 9.3.2 and Vol 6, Part B, Section 2.3.1.3 */
+ ADV_CONNECTABLE_UNDIRECTED, /**< Vol 3, Part C, Section 9.3.4 and
+ *Vol 6, Part B, Section 2.3.1.1 */
+ ADV_CONNECTABLE_DIRECTED, /**< Vol 3, Part C, Section 9.3.3 and
+ *Vol 6, Part B, Section 2.3.1.2 */
+ ADV_SCANNABLE_UNDIRECTED, /**< Include support for Scan Response
+ *payloads, see Vol 6, Part B, Section
+ *2.3.1.4 */
+ ADV_NON_CONNECTABLE_UNDIRECTED /**< Vol 3, Part C, Section 9.3.2 and
+ *Vol 6, Part B, Section 2.3.1.3 */
};
-
- GapAdvertisingParams(AdvertisingType advType = GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED,
- uint16_t interval = GAP_ADV_PARAMS_INTERVAL_MIN_NONCON,
- uint16_t timeout = 0);
+
+ GapAdvertisingParams(
+ AdvertisingType advType =
+ GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED,
+ uint16_t interval =
+ GAP_ADV_PARAMS_INTERVAL_MIN_NONCON,
+ uint16_t timeout = 0);
virtual ~GapAdvertisingParams(void);
-
+
virtual AdvertisingType getAdvertisingType(void);
virtual uint16_t getInterval(void);
virtual uint16_t getTimeout(void);
- private:
- AdvertisingType _advType;
- uint16_t _interval;
- uint16_t _timeout;
+private:
+ AdvertisingType _advType;
+ uint16_t _interval;
+ uint16_t _timeout;
};
-#endif
+#endif // ifndef __GAP_ADVERTISING_PARAMS_H__
