BTGattDesc.java

Go to the documentation of this file.

/**
 * Author: Sven Gothel <sgothel@jausoft.com>
 * Copyright (c) 2020 Gothel Software e.K.
 * Copyright (c) 2020 ZAFENA AB
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
package org.direct_bt;
 
/**
 * Representing a Gatt Characteristic Descriptor object from the GATT client perspective.
 *
 * A list of shared BTGattDesc instances is available from BTGattChar
 * via BTGattChar::getDescriptors().
 *
 * See [Direct-BT Overview](namespaceorg_1_1direct__bt.html#details).
 *
 * BT Core Spec v5.2: Vol 3, Part G GATT: 3.3.3 Characteristic Descriptor
 *
 * See {@link DBGattDesc.UUID16} for selected standard GATT descriptor numbers in UUID16 format
 * and {@link BTUtils#toUUID128(String)} for their conversion to UUID128.
 */
public interface BTGattDesc extends BTObject
{
    /** Reads the value of this descriptor
      * @return A vector<uchar> containing data from this descriptor
      */
    byte[] readValue();
 
    /** Writes the value of this descriptor.
      * @param[in] arg_value The data as vector<uchar>
      * to be written packed in a GBytes struct
      * @return TRUE if value was written succesfully
      */
    boolean writeValue(byte[] argValue) throws BTException;
 
    /** Get the UUID of this descriptor.
      * @return The 128 byte UUID of this descriptor, NULL if an error occurred
      */
    String getUUID();
 
    /** Returns the characteristic to which this descriptor belongs to.
      * @return The characteristic.
      */
    BTGattChar getCharacteristic();
 
    /** Returns the cached value of this descriptor, if any.
      * @return The cached value of this descriptor.
      */
    byte[] getValue();
 
    @Override
    String toString();
}