Lancaster University / BLE_API

Lancaster University's fork of the mbed BLE API. Lives on github, https://github.com/lancaster-university/BLE_API

Dependents:   microbit-dal microbit-dal microbit-ble-open microbit-dal ... more

Fork of BLE_API by Bluetooth Low Energy

ble/GattAttribute.h@1011:317d3b25018e, 2015-12-02 (annotated)

Committer:
rgrover1
Date:
Wed Dec 02 12:57:28 2015 +0000
Revision:
1011:317d3b25018e
Parent:
1008:c27e0c6f1f38
Child:
1017:ccb8c0646e55
Synchronized with git rev 87aeff34

Author: Andres Amaya Garcia

Allow GattAttributes to have fixed length



Previously the concepts of initLength and lenth were clearly separated.

However, this was at the cost of registering all characteristics in the

SoftDevice as having variable length. Clearly, this is not the desired

behaviour. Therefore, an additional field '_hasVariableLen' is added to the

GattAttribute to address the problem. Also, the GattAttribute and

GattCharacteristic constructors have been modified to take a boolean that

sets '_hasVariableLen'.

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 1008:c27e0c6f1f38 36 * @param[in] len
rgrover1 1008:c27e0c6f1f38 37 * The 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 1011:317d3b25018e 40 * @param[in] hasVariableLen
rgrover1 1011:317d3b25018e 41 * Whether the attribute's value length changes overtime.
rgrover1 710:b2e1a2660ec2 42 *
rgrover1 710:b2e1a2660ec2 43 * @section EXAMPLE
rgrover1 710:b2e1a2660ec2 44 *
rgrover1 710:b2e1a2660ec2 45 * @code
rgrover1 710:b2e1a2660ec2 46 *
rgrover1 710:b2e1a2660ec2 47 * // UUID = 0x2A19, Min length 2, Max len = 2
rgrover1 710:b2e1a2660ec2 48 * GattAttribute attr = GattAttribute(0x2A19, &someValue, 2, 2);
rgrover1 710:b2e1a2660ec2 49 *
rgrover1 710:b2e1a2660ec2 50 * @endcode
rgrover1 710:b2e1a2660ec2 51 */
rgrover1 1011:317d3b25018e 52 GattAttribute(const UUID &uuid, uint8_t *valuePtr = NULL, uint16_t len = 0, uint16_t maxLen = 0, bool hasVariableLen = true) :
rgrover1 1011:317d3b25018e 53 _uuid(uuid), _valuePtr(valuePtr), _lenMax(maxLen), _len(len), _hasVariableLen(hasVariableLen), _handle() {
rgrover1 993:4d62b7967c11 54 /* Empty */
rgrover1 710:b2e1a2660ec2 55 }
rgrover1 710:b2e1a2660ec2 56
rgrover1 710:b2e1a2660ec2 57 public:
rgrover1 1011:317d3b25018e 58 Handle_t getHandle(void) const {return _handle; }
rgrover1 1011:317d3b25018e 59 const UUID &getUUID(void) const {return _uuid; }
rgrover1 1011:317d3b25018e 60 uint16_t getLength(void) const {return _len; }
rgrover1 1011:317d3b25018e 61 uint16_t getMaxLength(void) const {return _lenMax; }
rgrover1 1011:317d3b25018e 62 uint16_t *getLengthPtr(void) {return &_len; }
rgrover1 1011:317d3b25018e 63 void setHandle(Handle_t id) {_handle = id; }
rgrover1 1011:317d3b25018e 64 uint8_t *getValuePtr(void) {return _valuePtr; }
rgrover1 1011:317d3b25018e 65 bool hasVariableLength(void) const {return _hasVariableLen;}
rgrover1 710:b2e1a2660ec2 66
rgrover1 710:b2e1a2660ec2 67 private:
rgrover1 1011:317d3b25018e 68 UUID _uuid; /* Characteristic UUID. */
rgrover1 710:b2e1a2660ec2 69 uint8_t *_valuePtr;
rgrover1 1011:317d3b25018e 70 uint16_t _lenMax; /* Maximum length of the value. */
rgrover1 1011:317d3b25018e 71 uint16_t _len; /* Current length of the value. */
rgrover1 1011:317d3b25018e 72 bool _hasVariableLen;
rgrover1 710:b2e1a2660ec2 73 Handle_t _handle;
rgrover1 710:b2e1a2660ec2 74
rgrover1 710:b2e1a2660ec2 75 private:
rgrover1 993:4d62b7967c11 76 /* Disallow copy and assignment. */
rgrover1 710:b2e1a2660ec2 77 GattAttribute(const GattAttribute &);
rgrover1 710:b2e1a2660ec2 78 GattAttribute& operator=(const GattAttribute &);
rgrover1 710:b2e1a2660ec2 79 };
rgrover1 710:b2e1a2660ec2 80
rgrover1 710:b2e1a2660ec2 81 #endif // ifndef __GATT_ATTRIBUTE_H__