Wang Xinglu / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependencies:   nRF51822

Dependents:   LinkNode_LIS3DH

Fork of BLE_API by Bluetooth Low Energy

ble/GattAttribute.h@993:4d62b7967c11, 2015-12-02 (annotated)

Committer:
rgrover1
Date:
Wed Dec 02 10:29:44 2015 +0000
Revision:
993:4d62b7967c11
Parent:
992:ca834f7ae8ed
Child:
996:14aeadec4695
Synchronized with git rev 12e27cd4

Author: Rohit Grover

Release 2.1.3

=============



* Improvements to CallChainOfFunctionPointerswithContext:

  - add a `detach` function to be able to remove callbacks.

  - detach function now return true if a function has been detached and

    false otherwise.

  - add a function call operator.

  - use safe-bool idiom. see : http://www.artima.com/cppsource/safebool.html



* Add SafeBool class which allow to easily declare a safe bool operator in

  c++03.



* Improvements to FunctionPointerWithContext:

  - fix call propagation

  - use safe bool idiom



* Add config file for generating Doxygen.



* Setup for onRadioNotification callback does not call initRadioNotification

  anymore.



* GapAdvertisementData now handles replacement and appending of data fields

  based on type. Some fields can be replaced with new values, and others

  require the payload to be appended.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 710:b2e1a2660ec2 1 /* mbed Microcontroller Library
rgrover1 710:b2e1a2660ec2 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 710:b2e1a2660ec2 3 *
rgrover1 710:b2e1a2660ec2 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 710:b2e1a2660ec2 5 * you may not use this file except in compliance with the License.
rgrover1 710:b2e1a2660ec2 6 * You may obtain a copy of the License at
rgrover1 710:b2e1a2660ec2 7 *
rgrover1 710:b2e1a2660ec2 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 710:b2e1a2660ec2 9 *
rgrover1 710:b2e1a2660ec2 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 710:b2e1a2660ec2 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 710:b2e1a2660ec2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 710:b2e1a2660ec2 13 * See the License for the specific language governing permissions and
rgrover1 710:b2e1a2660ec2 14 * limitations under the License.
rgrover1 710:b2e1a2660ec2 15 */
rgrover1 710:b2e1a2660ec2 16
rgrover1 710:b2e1a2660ec2 17 #ifndef __GATT_ATTRIBUTE_H__
rgrover1 710:b2e1a2660ec2 18 #define __GATT_ATTRIBUTE_H__
rgrover1 710:b2e1a2660ec2 19
rgrover1 710:b2e1a2660ec2 20 #include "UUID.h"
rgrover1 710:b2e1a2660ec2 21
rgrover1 710:b2e1a2660ec2 22 class GattAttribute {
rgrover1 710:b2e1a2660ec2 23 public:
rgrover1 710:b2e1a2660ec2 24 typedef uint16_t Handle_t;
rgrover1 710:b2e1a2660ec2 25 static const Handle_t INVALID_HANDLE = 0x0000;
rgrover1 710:b2e1a2660ec2 26
rgrover1 710:b2e1a2660ec2 27 public:
rgrover1 710:b2e1a2660ec2 28 /**
rgrover1 710:b2e1a2660ec2 29 * @brief Creates a new GattAttribute using the specified
rgrover1 993:4d62b7967c11 30 * UUID, value length, and inital value.
rgrover1 710:b2e1a2660ec2 31 *
rgrover1 710:b2e1a2660ec2 32 * @param[in] uuid
rgrover1 993:4d62b7967c11 33 * The UUID to use for this attribute.
rgrover1 710:b2e1a2660ec2 34 * @param[in] valuePtr
rgrover1 710:b2e1a2660ec2 35 * The memory holding the initial value.
rgrover1 710:b2e1a2660ec2 36 * @param[in] initialLen
rgrover1 993:4d62b7967c11 37 * The min length in bytes of this attribute's value.
rgrover1 710:b2e1a2660ec2 38 * @param[in] maxLen
rgrover1 993:4d62b7967c11 39 * The max length in bytes of this attribute's value.
rgrover1 710:b2e1a2660ec2 40 *
rgrover1 710:b2e1a2660ec2 41 * @section EXAMPLE
rgrover1 710:b2e1a2660ec2 42 *
rgrover1 710:b2e1a2660ec2 43 * @code
rgrover1 710:b2e1a2660ec2 44 *
rgrover1 710:b2e1a2660ec2 45 * // UUID = 0x2A19, Min length 2, Max len = 2
rgrover1 710:b2e1a2660ec2 46 * GattAttribute attr = GattAttribute(0x2A19, &someValue, 2, 2);
rgrover1 710:b2e1a2660ec2 47 *
rgrover1 710:b2e1a2660ec2 48 * @endcode
rgrover1 710:b2e1a2660ec2 49 */
rgrover1 710:b2e1a2660ec2 50 GattAttribute(const UUID &uuid, uint8_t *valuePtr = NULL, uint16_t initialLen = 0, uint16_t maxLen = 0) :
rgrover1 710:b2e1a2660ec2 51 _uuid(uuid), _valuePtr(valuePtr), _initialLen(initialLen), _lenMax(maxLen), _len(initialLen), _handle() {
rgrover1 993:4d62b7967c11 52 /* Empty */
rgrover1 710:b2e1a2660ec2 53 }
rgrover1 710:b2e1a2660ec2 54
rgrover1 710:b2e1a2660ec2 55 public:
rgrover1 710:b2e1a2660ec2 56 Handle_t getHandle(void) const {return _handle; }
rgrover1 710:b2e1a2660ec2 57 const UUID &getUUID(void) const {return _uuid; }
rgrover1 710:b2e1a2660ec2 58 uint16_t getLength(void) const {return _len; }
rgrover1 710:b2e1a2660ec2 59 uint16_t getInitialLength(void) const {return _initialLen;}
rgrover1 710:b2e1a2660ec2 60 uint16_t getMaxLength(void) const {return _lenMax; }
rgrover1 710:b2e1a2660ec2 61 uint16_t *getLengthPtr(void) {return &_len; }
rgrover1 710:b2e1a2660ec2 62 void setHandle(Handle_t id) {_handle = id; }
rgrover1 710:b2e1a2660ec2 63 uint8_t *getValuePtr(void) {return _valuePtr; }
rgrover1 710:b2e1a2660ec2 64
rgrover1 710:b2e1a2660ec2 65 private:
rgrover1 993:4d62b7967c11 66 UUID _uuid; /* Characteristic UUID. */
rgrover1 710:b2e1a2660ec2 67 uint8_t *_valuePtr;
rgrover1 993:4d62b7967c11 68 uint16_t _initialLen; /* Initial length of the value. */
rgrover1 993:4d62b7967c11 69 uint16_t _lenMax; /* Maximum length of the value. */
rgrover1 993:4d62b7967c11 70 uint16_t _len; /* Current length of the value. */
rgrover1 710:b2e1a2660ec2 71 Handle_t _handle;
rgrover1 710:b2e1a2660ec2 72
rgrover1 710:b2e1a2660ec2 73 private:
rgrover1 993:4d62b7967c11 74 /* Disallow copy and assignment. */
rgrover1 710:b2e1a2660ec2 75 GattAttribute(const GattAttribute &);
rgrover1 710:b2e1a2660ec2 76 GattAttribute& operator=(const GattAttribute &);
rgrover1 710:b2e1a2660ec2 77 };
rgrover1 710:b2e1a2660ec2 78
rgrover1 710:b2e1a2660ec2 79 #endif // ifndef __GATT_ATTRIBUTE_H__