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@1048:efb29faf12fc, 2016-01-11 (annotated)

Committer:
vcoubard
Date:
Mon Jan 11 08:51:28 2016 +0000
Revision:
1048:efb29faf12fc
Parent:
1042:21a86ac7f5b1
Child:
1053:ec4a5b9b254e
Synchronized with git rev 08978591

Author: Vincent Coubard

Merge remote-tracking branch 'origin/develop' into descriptorDiscovery

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
vcoubard 1048:efb29faf12fc 30 * UUID, value length, and inital value.
rgrover1 710:b2e1a2660ec2 31 *
rgrover1 710:b2e1a2660ec2 32 * @param[in] uuid
vcoubard 1048:efb29faf12fc 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.
vcoubard 1042:21a86ac7f5b1 36 * @param[in] initialLen
vcoubard 1048:efb29faf12fc 37 * The min length in bytes of this attribute's value.
rgrover1 710:b2e1a2660ec2 38 * @param[in] maxLen
vcoubard 1048:efb29faf12fc 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 */
vcoubard 1042:21a86ac7f5b1 50 GattAttribute(const UUID &uuid, uint8_t *valuePtr = NULL, uint16_t initialLen = 0, uint16_t maxLen = 0) :
vcoubard 1042:21a86ac7f5b1 51 _uuid(uuid), _valuePtr(valuePtr), _initialLen(initialLen), _lenMax(maxLen), _len(initialLen), _handle() {
vcoubard 1048:efb29faf12fc 52 /* Empty */
rgrover1 710:b2e1a2660ec2 53 }
rgrover1 710:b2e1a2660ec2 54
rgrover1 710:b2e1a2660ec2 55 public:
vcoubard 1042:21a86ac7f5b1 56 Handle_t getHandle(void) const {return _handle; }
vcoubard 1042:21a86ac7f5b1 57 const UUID &getUUID(void) const {return _uuid; }
vcoubard 1042:21a86ac7f5b1 58 uint16_t getLength(void) const {return _len; }
vcoubard 1042:21a86ac7f5b1 59 uint16_t getInitialLength(void) const {return _initialLen;}
vcoubard 1042:21a86ac7f5b1 60 uint16_t getMaxLength(void) const {return _lenMax; }
vcoubard 1042:21a86ac7f5b1 61 uint16_t *getLengthPtr(void) {return &_len; }
vcoubard 1042:21a86ac7f5b1 62 void setHandle(Handle_t id) {_handle = id; }
vcoubard 1042:21a86ac7f5b1 63 uint8_t *getValuePtr(void) {return _valuePtr; }
rgrover1 710:b2e1a2660ec2 64
rgrover1 710:b2e1a2660ec2 65 private:
vcoubard 1048:efb29faf12fc 66 UUID _uuid; /* Characteristic UUID. */
rgrover1 710:b2e1a2660ec2 67 uint8_t *_valuePtr;
vcoubard 1048:efb29faf12fc 68 uint16_t _initialLen; /* Initial length of the value. */
vcoubard 1048:efb29faf12fc 69 uint16_t _lenMax; /* Maximum length of the value. */
vcoubard 1048:efb29faf12fc 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:
vcoubard 1048:efb29faf12fc 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__