Lancaster University
/
BLE_API
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.
Dependents: microbit-dal microbit-dal microbit-ble-open microbit-dal ... more
Fork of
BLE_API
by 
Bluetooth Low Energy
Diff: public/GapAdvertisingParams.h
- Revision:
- 260:ea7f9f14cc15
- Parent:
- 144:c025c8839682
- Child:
- 329:2e082a9c7c13
diff -r a95264ad705c -r ea7f9f14cc15 public/GapAdvertisingParams.h
--- a/public/GapAdvertisingParams.h Wed Jan 21 09:32:48 2015 +0000
+++ b/public/GapAdvertisingParams.h Wed Jan 21 09:32:49 2015 +0000
@@ -1,86 +1,86 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
-*/
-
-#ifndef __GAP_ADVERTISING_PARAMS_H__
-#define __GAP_ADVERTISING_PARAMS_H__
-
-/**************************************************************************/
-/*!
- \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
-*/
-/**************************************************************************/
-class GapAdvertisingParams {
-public:
- static const unsigned GAP_ADV_PARAMS_INTERVAL_MIN = 0x0020;
- static const unsigned GAP_ADV_PARAMS_INTERVAL_MIN_NONCON = 0x00A0;
- static const unsigned GAP_ADV_PARAMS_INTERVAL_MAX = 0x4000;
- static const unsigned GAP_ADV_PARAMS_TIMEOUT_MAX = 0x3FFF;
-
- /**************************************************************************/
- /*!
- \brief
- Encapsulates the peripheral advertising modes, which determine how
- the device appears to other central devices in hearing range
-
- \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 */
- };
-
-public:
- GapAdvertisingParams(AdvertisingType advType = GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED,
- uint16_t interval = GAP_ADV_PARAMS_INTERVAL_MIN_NONCON,
- uint16_t timeout = 0);
- virtual ~GapAdvertisingParams(void);
-
- AdvertisingType getAdvertisingType(void) const {return _advType; }
- uint16_t getInterval(void) const {return _interval;}
- uint16_t getTimeout(void) const {return _timeout; }
-
- void setAdvertisingType(AdvertisingType newAdvType) {_advType = newAdvType; }
- void setInterval(uint16_t newInterval) {_interval = newInterval;}
- void setTimeout(uint16_t newTimeout) {_timeout = newTimeout; }
-
-private:
- AdvertisingType _advType;
- uint16_t _interval;
- uint16_t _timeout;
-
-private:
- /* disallow copy constructor */
- GapAdvertisingParams(const GapAdvertisingParams &);
-};
-
-#endif // ifndef __GAP_ADVERTISING_PARAMS_H__
\ No newline at end of file
+/* mbed Microcontroller Library
+ * Copyright (c) 2006-2013 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/
+
+#ifndef __GAP_ADVERTISING_PARAMS_H__
+#define __GAP_ADVERTISING_PARAMS_H__
+
+/**************************************************************************/
+/*!
+ \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
+*/
+/**************************************************************************/
+class GapAdvertisingParams {
+public:
+ static const unsigned GAP_ADV_PARAMS_INTERVAL_MIN = 0x0020;
+ static const unsigned GAP_ADV_PARAMS_INTERVAL_MIN_NONCON = 0x00A0;
+ static const unsigned GAP_ADV_PARAMS_INTERVAL_MAX = 0x4000;
+ static const unsigned GAP_ADV_PARAMS_TIMEOUT_MAX = 0x3FFF;
+
+ /**************************************************************************/
+ /*!
+ \brief
+ Encapsulates the peripheral advertising modes, which determine how
+ the device appears to other central devices in hearing range
+
+ \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 */
+ };
+
+public:
+ GapAdvertisingParams(AdvertisingType advType = GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED,
+ uint16_t interval = GAP_ADV_PARAMS_INTERVAL_MIN_NONCON,
+ uint16_t timeout = 0);
+ virtual ~GapAdvertisingParams(void);
+
+ AdvertisingType getAdvertisingType(void) const {return _advType; }
+ uint16_t getInterval(void) const {return _interval;}
+ uint16_t getTimeout(void) const {return _timeout; }
+
+ void setAdvertisingType(AdvertisingType newAdvType) {_advType = newAdvType; }
+ void setInterval(uint16_t newInterval) {_interval = newInterval;}
+ void setTimeout(uint16_t newTimeout) {_timeout = newTimeout; }
+
+private:
+ AdvertisingType _advType;
+ uint16_t _interval;
+ uint16_t _timeout;
+
+private:
+ /* disallow copy constructor */
+ GapAdvertisingParams(const GapAdvertisingParams &);
+};
+
+#endif // ifndef __GAP_ADVERTISING_PARAMS_H__
\ No newline at end of file