Direct-BT v3.3.0-1-gc2d430c
Direct-BT - Direct Bluetooth Programming.
Public Member Functions | List of all members
org.direct_bt.BTGattDesc Interface Reference

Representing a Gatt Characteristic Descriptor object from the GATT client perspective. More...

Inheritance diagram for org.direct_bt.BTGattDesc:
Collaboration diagram for org.direct_bt.BTGattDesc:

Public Member Functions

BTGattChar getCharacteristic ()
 Returns the characteristic to which this descriptor belongs to. More...
 
String getUUID ()
 Get the UUID of this descriptor. More...
 
byte[] getValue ()
 Returns the cached value of this descriptor, if any. More...
 
byte[] readValue ()
 Reads the value of this descriptor. More...
 
String toString ()
 
boolean writeValue (byte[] argValue) throws BTException
 Writes the value of this descriptor. More...
 
- Public Member Functions inherited from org.direct_bt.BTObject
void close ()
 Release the native memory associated with this object The object should not be used following a call to close. More...
 
boolean equals (Object obj)
 
int hashCode ()
 

Detailed Description

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.

BT Core Spec v5.2: Vol 3, Part G GATT: 3.3.3 Characteristic Descriptor

See DBGattDesc.UUID16 for selected standard GATT descriptor numbers in UUID16 format and BTUtils#toUUID128(String) for their conversion to UUID128.

Definition at line 41 of file BTGattDesc.java.

Member Function Documentation

◆ readValue()

byte[] org.direct_bt.BTGattDesc.readValue ( )

Reads the value of this descriptor.

Returns
A vector<uchar> containing data from this descriptor

Implemented in jau.direct_bt.DBTGattDesc.

◆ writeValue()

boolean org.direct_bt.BTGattDesc.writeValue ( byte[]  argValue) throws BTException

Writes the value of this descriptor.

Parameters
[in]arg_valueThe data as vector<uchar> to be written packed in a GBytes struct
Returns
TRUE if value was written succesfully

Implemented in jau.direct_bt.DBTGattDesc.

◆ getUUID()

String org.direct_bt.BTGattDesc.getUUID ( )

Get the UUID of this descriptor.

Returns
The 128 byte UUID of this descriptor, NULL if an error occurred

Implemented in jau.direct_bt.DBTGattDesc.

◆ getCharacteristic()

BTGattChar org.direct_bt.BTGattDesc.getCharacteristic ( )

Returns the characteristic to which this descriptor belongs to.

Returns
The characteristic.

Implemented in jau.direct_bt.DBTGattDesc.

◆ getValue()

byte[] org.direct_bt.BTGattDesc.getValue ( )

Returns the cached value of this descriptor, if any.

Returns
The cached value of this descriptor.

Implemented in jau.direct_bt.DBTGattDesc.

◆ toString()

String org.direct_bt.BTGattDesc.toString ( )

Implemented in jau.direct_bt.DBTGattDesc.


The documentation for this interface was generated from the following file: