ej.bluetooth

Class BluetoothAttribute

java.lang.Object

ej.bluetooth.BluetoothAttribute

Direct Known Subclasses:

BluetoothCharacteristic, BluetoothDescriptor

public class BluetoothAttribute
extends java.lang.Object

The BluetoothAttribute class represents a remote or a local GATT attribute.

This class provides methods to get information on the attribute. It also provides methods to send read or write requests to a remote attribute, and methods to send read or write responses on a local attribute.

Please refer to the child classes documentation for more information.

Method Summary

Modifier and Type	Method and Description
BluetoothService	getService() Returns the service to which this attribute belongs.
BluetoothUuid	getUuid() Returns the UUID of this attribute.
boolean	sendReadRequest() Sends a read request on this attribute.
boolean	sendReadResponse(BluetoothDevice device, int status, byte[] value) Sends the response to a read request sent by the given device on this attribute.
boolean	sendWriteRequest(byte[] value) Sends a write request on this attribute with the given value.
boolean	sendWriteResponse(BluetoothDevice device, int status) Sends the response to a write request sent by the given device on this attribute.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUuid

public BluetoothUuid getUuid()

Returns the UUID of this attribute.

Returns:

the UUID of this attribute.

getService

public BluetoothService getService()

Returns the service to which this attribute belongs.

This method returns null if this is a local attribute which has not been added to a service.

Returns:

the service to which this attribute belongs.

sendReadRequest

public boolean sendReadRequest()

Sends a read request on this attribute.

Returns:

true if the read request was sent successfully.

Throws:

java.lang.IllegalStateException - if this attribute does not belong to a remote device.

See Also:

ClientCallbacks.onReadCompleted(BluetoothCharacteristic, int, byte[]), ClientCallbacks.onReadCompleted(BluetoothDescriptor, int, byte[])

sendWriteRequest

public boolean sendWriteRequest(byte[] value)

Sends a write request on this attribute with the given value.

Parameters:

value - the value to write.

Returns:

true if the write request was sent successfully.

Throws:

java.lang.IllegalStateException - if this attribute does not belong to a remote device.

See Also:

ClientCallbacks.onWriteCompleted(BluetoothCharacteristic, int), ClientCallbacks.onWriteCompleted(BluetoothDescriptor, int)

sendReadResponse

public boolean sendReadResponse(BluetoothDevice device,
                                int status,
                                byte[] value)

Sends the response to a read request sent by the given device on this attribute.

Parameters:

device - the device which sent the request.

status - the status to send back (see BluetoothStatus).

value - the value to send back.

Returns:

true if the read response was sent successfully.

Throws:

java.lang.IllegalStateException - if this attribute belongs to a remote device.

java.lang.IllegalStateException - if this attribute has not been added to a service

java.lang.IllegalStateException - if the service of this attribute has not been added to an adapter.

sendWriteResponse

public boolean sendWriteResponse(BluetoothDevice device,
                                 int status)

Sends the response to a write request sent by the given device on this attribute.

Parameters:

device - the device which sent the request.

status - the status to send back (see BluetoothStatus).

Returns:

true if the write response was sent successfully.

Throws:

java.lang.IllegalStateException - if this attribute belongs to a remote device.

java.lang.IllegalStateException - if this attribute has not been added to a service

java.lang.IllegalStateException - if the service of this attribute has not been added to an adapter.