YUFEI JIANG / BLE_API_Tiny_BLE

BLE_API_Tiny_BLE

Dependents:   CSSE4011_BLE_IMU

Fork of BLE_API by Bluetooth Low Energy

public/GattAttribute.h@344:241987ac6b8b, 2015-04-30 (annotated)

Committer:
rgrover1
Date:
Thu Apr 30 08:37:21 2015 +0100
Revision:
344:241987ac6b8b
Parent:
304:30618b2c9808 
Synchronized with git rev 0833b458

Author: Rohit Grover

fixes #37: correct the comment block header for GattAttribute's constructor.

Who changed what in which revision?

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