Skip to content

Most visited

Recently visited

navigation

BluetoothGattServerCallback

public abstract class BluetoothGattServerCallback
extends Object

java.lang.Object
   ↳ android.bluetooth.BluetoothGattServerCallback


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 readPhy(BluetoothDevice)

void onPhyUpdate(BluetoothDevice device, int txPhy, int rxPhy, int status)

Callback triggered as result of setPreferredPhy(BluetoothDevice, int, int, int), 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.

Inherited methods

From class java.lang.Object

Public constructors

BluetoothGattServerCallback

added in API level 18
BluetoothGattServerCallback ()

Public methods

onCharacteristicReadRequest

added in API level 18
void onCharacteristicReadRequest (BluetoothDevice device, 
                int requestId, 
                int offset, 
                BluetoothGattCharacteristic characteristic)

A remote client has requested to read a local characteristic.

An application must call sendResponse(BluetoothDevice, int, int, int, byte[]) 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

added in API level 18
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 sendResponse(BluetoothDevice, int, int, int, byte[]) 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

added in API level 18
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 STATE_DISCONNECTED or STATE_CONNECTED

onDescriptorReadRequest

added in API level 18
void onDescriptorReadRequest (BluetoothDevice device, 
                int requestId, 
                int offset, 
                BluetoothGattDescriptor descriptor)

A remote client has requested to read a local descriptor.

An application must call sendResponse(BluetoothDevice, int, int, int, byte[]) 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

added in API level 18
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 sendResponse(BluetoothDevice, int, int, int, byte[]) 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

added in API level 18
void onExecuteWrite (BluetoothDevice device, 
                int requestId, 
                boolean execute)

Execute all pending write operations for this device.

An application must call sendResponse(BluetoothDevice, int, int, int, byte[]) 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

added in API level 22
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

added in API level 21
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: GATT_SUCCESS if the operation was successful

onPhyRead

added in API level 26
void onPhyRead (BluetoothDevice device, 
                int txPhy, 
                int rxPhy, 
                int status)

Callback triggered as result of readPhy(BluetoothDevice)

Parameters
device BluetoothDevice: The remote device that requested the PHY read

txPhy int: the transmitter PHY in use. One of PHY_LE_1M, PHY_LE_2M, and PHY_LE_CODED

rxPhy int: the receiver PHY in use. One of PHY_LE_1M, PHY_LE_2M, and PHY_LE_CODED

status int: Status of the PHY read operation. GATT_SUCCESS if the operation succeeds.

onPhyUpdate

added in API level 26
void onPhyUpdate (BluetoothDevice device, 
                int txPhy, 
                int rxPhy, 
                int status)

Callback triggered as result of setPreferredPhy(BluetoothDevice, int, int, int), or as a result of remote device changing the PHY.

Parameters
device BluetoothDevice: The remote device

txPhy int: the transmitter PHY in use. One of PHY_LE_1M, PHY_LE_2M, and PHY_LE_CODED

rxPhy int: the receiver PHY in use. One of PHY_LE_1M, PHY_LE_2M, and PHY_LE_CODED

status int: Status of the PHY update operation. GATT_SUCCESS if the operation succeeds.

onServiceAdded

added in API level 18
void onServiceAdded (int status, 
                BluetoothGattService service)

Indicates whether a local service has been added successfully.

Parameters
status int: Returns GATT_SUCCESS if the service was added successfully.

service BluetoothGattService: The service that has been added

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.