BluetoothGattServerCallback

BluetoothGattServerCallback | API reference | Android Developers

Summary: Ctors | Methods | Inherited Methods

public abstract class BluetoothGattServerCallback
extends Object

This abstract class is used to implement BluetoothGattServer callbacks.

Summary

Public constructors
`BluetoothGattServerCallback()`

Public methods
`void`	`onCharacteristicReadRequest(BluetoothDevice device, int requestId, int offset, BluetoothGattCharacteristic characteristic)` A remote client has requested to read a local characteristic.
`void`	`onCharacteristicWriteRequest(BluetoothDevice device, int requestId, BluetoothGattCharacteristic characteristic, boolean preparedWrite, boolean responseNeeded, int offset, byte[] value)` A remote client has requested to write to a local characteristic.
`void`	`onConnectionStateChange(BluetoothDevice device, int status, int newState)` Callback indicating when a remote device has been connected or disconnected.
`void`	`onDescriptorReadRequest(BluetoothDevice device, int requestId, int offset, BluetoothGattDescriptor descriptor)` A remote client has requested to read a local descriptor.
`void`	`onDescriptorWriteRequest(BluetoothDevice device, int requestId, BluetoothGattDescriptor descriptor, boolean preparedWrite, boolean responseNeeded, int offset, byte[] value)` A remote client has requested to write to a local descriptor.
`void`	`onExecuteWrite(BluetoothDevice device, int requestId, boolean execute)` Execute all pending write operations for this device.
`void`	`onMtuChanged(BluetoothDevice device, int mtu)` Callback indicating the MTU for a given device connection has changed.
`void`	`onNotificationSent(BluetoothDevice device, int status)` Callback invoked when a notification or indication has been sent to a remote device.
`void`	`onPhyRead(BluetoothDevice device, int txPhy, int rxPhy, int status)` Callback triggered as result of `BluetoothGattServer.readPhy`
`void`	`onPhyUpdate(BluetoothDevice device, int txPhy, int rxPhy, int status)` Callback triggered as result of `BluetoothGattServer.setPreferredPhy`, or as a result of remote device changing the PHY.
`void`	`onServiceAdded(int status, BluetoothGattService service)` Indicates whether a local service has been added successfully.
`void`	`onSubrateChange(BluetoothDevice device, int subrateMode, int status)` Callback indicating LE connection's subrate parameters have changed.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

public BluetoothGattServerCallback ()

Public methods

onCharacteristicReadRequest

public void onCharacteristicReadRequest (BluetoothDevice device, 
                int requestId, 
                int offset, 
                BluetoothGattCharacteristic characteristic)

A remote client has requested to read a local characteristic.

An application must call BluetoothGattServer.sendResponse to complete the request.

Parameters
`device`	`BluetoothDevice`: The remote device that has requested the read operation
`requestId`	`int`: The Id of the request
`offset`	`int`: Offset into the value of the characteristic
`characteristic`	`BluetoothGattCharacteristic`: Characteristic to be read

onCharacteristicWriteRequest

public void onCharacteristicWriteRequest (BluetoothDevice device, 
                int requestId, 
                BluetoothGattCharacteristic characteristic, 
                boolean preparedWrite, 
                boolean responseNeeded, 
                int offset, 
                byte[] value)

A remote client has requested to write to a local characteristic.

An application must call BluetoothGattServer.sendResponse to complete the request.

Parameters
`device`	`BluetoothDevice`: The remote device that has requested the write operation
`requestId`	`int`: The Id of the request
`characteristic`	`BluetoothGattCharacteristic`: Characteristic to be written to.
`preparedWrite`	`boolean`: true, if this write operation should be queued for later execution.
`responseNeeded`	`boolean`: true, if the remote device requires a response
`offset`	`int`: The offset given for the value
`value`	`byte`: The value the client wants to assign to the characteristic

onConnectionStateChange

public void onConnectionStateChange (BluetoothDevice device, 
                int status, 
                int newState)

Callback indicating when a remote device has been connected or disconnected.

Parameters
`device`	`BluetoothDevice`: Remote device that has been connected or disconnected.
`status`	`int`: Status of the connect or disconnect operation.
`newState`	`int`: Returns the new connection state. Can be one of `BluetoothProfile.STATE_DISCONNECTED` or `BluetoothProfile.STATE_CONNECTED`

onDescriptorReadRequest

public void onDescriptorReadRequest (BluetoothDevice device, 
                int requestId, 
                int offset, 
                BluetoothGattDescriptor descriptor)

A remote client has requested to read a local descriptor.

An application must call BluetoothGattServer.sendResponse to complete the request.

Parameters
`device`	`BluetoothDevice`: The remote device that has requested the read operation
`requestId`	`int`: The Id of the request
`offset`	`int`: Offset into the value of the characteristic
`descriptor`	`BluetoothGattDescriptor`: Descriptor to be read

onDescriptorWriteRequest

public void onDescriptorWriteRequest (BluetoothDevice device, 
                int requestId, 
                BluetoothGattDescriptor descriptor, 
                boolean preparedWrite, 
                boolean responseNeeded, 
                int offset, 
                byte[] value)

A remote client has requested to write to a local descriptor.

An application must call BluetoothGattServer.sendResponse to complete the request.

Parameters
`device`	`BluetoothDevice`: The remote device that has requested the write operation
`requestId`	`int`: The Id of the request
`descriptor`	`BluetoothGattDescriptor`: Descriptor to be written to.
`preparedWrite`	`boolean`: true, if this write operation should be queued for later execution.
`responseNeeded`	`boolean`: true, if the remote device requires a response
`offset`	`int`: The offset given for the value
`value`	`byte`: The value the client wants to assign to the descriptor

onExecuteWrite

public void onExecuteWrite (BluetoothDevice device, 
                int requestId, 
                boolean execute)

Execute all pending write operations for this device.

An application must call BluetoothGattServer.sendResponse to complete the request.

Parameters
`device`	`BluetoothDevice`: The remote device that has requested the write operations
`requestId`	`int`: The Id of the request
`execute`	`boolean`: Whether the pending writes should be executed (true) or cancelled (false)

onMtuChanged

public void onMtuChanged (BluetoothDevice device, 
                int mtu)

Callback indicating the MTU for a given device connection has changed.

This callback will be invoked if a remote client has requested to change the MTU for a given connection.

Parameters
`device`	`BluetoothDevice`: The remote device that requested the MTU change
`mtu`	`int`: The new MTU size

onNotificationSent

public void onNotificationSent (BluetoothDevice device, 
                int status)

Callback invoked when a notification or indication has been sent to a remote device.

When multiple notifications are to be sent, an application must wait for this callback to be received before sending additional notifications.

Parameters
`device`	`BluetoothDevice`: The remote device the notification has been sent to
`status`	`int`: `BluetoothGatt.GATT_SUCCESS` if the operation was successful

onServiceAdded

public void onServiceAdded (int status, 
                BluetoothGattService service)

Indicates whether a local service has been added successfully.

Parameters
`status`	`int`: Returns `BluetoothGatt.GATT_SUCCESS` if the service was added successfully.
`service`	`BluetoothGattService`: The service that has been added