File content as of revision 1029:a5d0fec3b17c:

/* mbed Microcontroller Library
 * Copyright (c) 2006-2013 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __GATT_ATTRIBUTE_H__
#define __GATT_ATTRIBUTE_H__

#include "UUID.h"

class GattAttribute {
public:
    typedef uint16_t Handle_t;
    static const Handle_t INVALID_HANDLE = 0x0000;

public:
    /**
     *  @brief  Creates a new GattAttribute using the specified
     *          UUID, value length, and inital value.
     *
     *  @param[in]  uuid
     *              The UUID to use for this attribute.
     *  @param[in]  valuePtr
     *              The memory holding the initial value.
     *  @param[in]  len
     *              The length in bytes of this attribute's value.
     *  @param[in]  maxLen
     *              The max length in bytes of this attribute's value.
     *  @param[in]  hasVariableLen
     *              Whether the attribute's value length changes overtime.
     *
     *  @section EXAMPLE
     *
     *  @code
     *
     *  // UUID = 0x2A19, Min length 2, Max len = 2
     *  GattAttribute attr = GattAttribute(0x2A19, &someValue, 2, 2);
     *
     *  @endcode
     */
    GattAttribute(const UUID &uuid, uint8_t *valuePtr = NULL, uint16_t len = 0, uint16_t maxLen = 0, bool hasVariableLen = true) :
        _uuid(uuid), _valuePtr(valuePtr), _lenMax(maxLen), _len(len), _hasVariableLen(hasVariableLen), _handle() {
        /* Empty */
    }

public:
    Handle_t    getHandle(void)         const {return _handle;        }
    const UUID &getUUID(void)           const {return _uuid;          }
    uint16_t    getLength(void)         const {return _len;           }
    uint16_t    getMaxLength(void)      const {return _lenMax;        }
    uint16_t   *getLengthPtr(void)            {return &_len;          }
    void        setHandle(Handle_t id)        {_handle = id;          }
    uint8_t    *getValuePtr(void)             {return _valuePtr;      }
    bool        hasVariableLength(void) const {return _hasVariableLen;}

private:
    UUID      _uuid;           /* Characteristic UUID. */
    uint8_t  *_valuePtr;
    uint16_t  _lenMax;         /* Maximum length of the value. */
    uint16_t  _len;            /* Current length of the value. */
    bool      _hasVariableLen;
    Handle_t  _handle;

private:
    /* Disallow copy and assignment. */
    GattAttribute(const GattAttribute &);
    GattAttribute& operator=(const GattAttribute &);
};

#endif // ifndef __GATT_ATTRIBUTE_H__