Oscar Ariza / BLE_API

BLE

Fork of BLE_API by Bluetooth Low Energy

ble/GattAttribute.h@1131:ff83f0020480, 2016-01-12 (annotated)

Committer:
vcoubard
Date:
Tue Jan 12 19:47:52 2016 +0000
Revision:
1131:ff83f0020480
Parent:
1055:f59e5d9a992a 
Synchronized with git rev e0f693ad

Author: Vincent Coubard

version v2.5.0

Who changed what in which revision?

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