Most visited

Recently visited

Results for

Added in API level 18

Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

BluetoothGattServer

public final class BluetoothGattServer
extends Object implements BluetoothProfile

java.lang.Object
↳	android.bluetooth.BluetoothGattServer

Public API for the Bluetooth GATT Profile server role.

This class provides Bluetooth GATT server role functionality, allowing applications to create Bluetooth Smart services and characteristics.

BluetoothGattServer is a proxy object for controlling the Bluetooth Service via IPC. Use openGattServer(Context, BluetoothGattServerCallback) to get an instance of this class.

Summary

Inherited constants

From interface


    android.bluetooth.BluetoothProfile

Public methods
`boolean`	`addService(BluetoothGattService service)` Add a service to the list of services to be hosted.
`void`	`cancelConnection(BluetoothDevice device)` Disconnects an established connection, or cancels a connection attempt currently in progress.
`void`	`clearServices()` Remove all services from the list of provided services.
`void`	`close()` Close this GATT server instance.
`boolean`	`connect(BluetoothDevice device, boolean autoConnect)` Initiate a connection to a Bluetooth GATT capable device.
`List<BluetoothDevice>`	`getConnectedDevices()` Not supported - please use `getConnectedDevices(int)` with `GATT` as argument
`int`	`getConnectionState(BluetoothDevice device)` Not supported - please use `getConnectedDevices(int)` with `GATT` as argument
`List<BluetoothDevice>`	`getDevicesMatchingConnectionStates(int[] states)` Not supported - please use `getDevicesMatchingConnectionStates(int, int[])` with `GATT` as first argument
`BluetoothGattService`	`getService(UUID uuid)` Returns a `BluetoothGattService` from the list of services offered by this device.
`List<BluetoothGattService>`	`getServices()` Returns a list of GATT services offered by this device.
`boolean`	`notifyCharacteristicChanged(BluetoothDevice device, BluetoothGattCharacteristic characteristic, boolean confirm)` Send a notification or indication that a local characteristic has been updated.
`boolean`	`removeService(BluetoothGattService service)` Removes a service from the list of services to be provided.
`boolean`	`sendResponse(BluetoothDevice device, int requestId, int status, int offset, byte[] value)` Send a response to a read or write request to a remote device.

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 millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    android.bluetooth.BluetoothProfile

Public methods

addService

Added in API level 18

boolean addService (BluetoothGattService service)

Add a service to the list of services to be hosted.

Once a service has been addded to the the list, the service and its included characteristics will be provided by the local device.

If the local device has already exposed services when this function is called, a service update notification will be sent to all clients.

Requires BLUETOOTH permission.

Parameters
`service`	`BluetoothGattService`: Service to be added to the list of services provided by this device.

Returns
`boolean`	true, if the service has been added successfully

cancelConnection

Added in API level 18

void cancelConnection (BluetoothDevice device)

Disconnects an established connection, or cancels a connection attempt currently in progress.

Requires BLUETOOTH permission.

Parameters
`device`	`BluetoothDevice`: Remote device

clearServices

Added in API level 18

void clearServices ()

Remove all services from the list of provided services.

Requires BLUETOOTH permission.

close

Added in API level 18

void close ()

Close this GATT server instance. Application should call this method as early as possible after it is done with this GATT server.

connect

Added in API level 18

boolean connect (BluetoothDevice device, 
                boolean autoConnect)

Initiate a connection to a Bluetooth GATT capable device.

The connection may not be established right away, but will be completed when the remote device is available. A onConnectionStateChange(BluetoothDevice, int, int) callback will be invoked when the connection state changes as a result of this function.

The autoConnect paramter determines whether to actively connect to the remote device, or rather passively scan and finalize the connection when the remote device is in range/available. Generally, the first ever connection to a device should be direct (autoConnect set to false) and subsequent connections to known devices should be invoked with the autoConnect parameter set to true.

Requires BLUETOOTH permission.

Parameters
`device`	`BluetoothDevice`
`autoConnect`	`boolean`: Whether to directly connect to the remote device (false) or to automatically connect as soon as the remote device becomes available (true).

Returns
`boolean`	true, if the connection attempt was initiated successfully

getConnectedDevices

Added in API level 18

List<BluetoothDevice> getConnectedDevices ()

Not supported - please use getConnectedDevices(int) with GATT as argument

Returns
`List<BluetoothDevice>`	List of devices. The list will be empty on error.

Throws
`UnsupportedOperationException`

getConnectionState

Added in API level 18

int getConnectionState (BluetoothDevice device)

Not supported - please use getConnectedDevices(int) with GATT as argument

Parameters
`device`	`BluetoothDevice`: Remote bluetooth device.

Returns
`int`	State of the profile connection. One of `STATE_CONNECTED`, `STATE_CONNECTING`, `STATE_DISCONNECTED`, `STATE_DISCONNECTING`

Throws
`UnsupportedOperationException`

getDevicesMatchingConnectionStates

Added in API level 18

List<BluetoothDevice> getDevicesMatchingConnectionStates (int[] states)

Not supported - please use getDevicesMatchingConnectionStates(int, int[]) with GATT as first argument

Parameters
`states`	`int`: Array of states. States can be one of `STATE_CONNECTED`, `STATE_CONNECTING`, `STATE_DISCONNECTED`, `STATE_DISCONNECTING`,

Returns
`List<BluetoothDevice>`	List of devices. The list will be empty on error.

Throws
`UnsupportedOperationException`

getService

Added in API level 18

BluetoothGattService getService (UUID uuid)

Returns a BluetoothGattService from the list of services offered by this device.

If multiple instances of the same service (as identified by UUID) exist, the first instance of the service is returned.

Requires BLUETOOTH permission.

Parameters
`uuid`	`UUID`: UUID of the requested service

Returns
`BluetoothGattService`	BluetoothGattService if supported, or null if the requested service is not offered by this device.

getServices

Added in API level 18

List<BluetoothGattService> getServices ()

Returns a list of GATT services offered by this device.

An application must call addService(BluetoothGattService) to add a serice to the list of services offered by this device.

Requires BLUETOOTH permission.

Returns
`List<BluetoothGattService>`	List of services. Returns an empty list if no services have been added yet.

notifyCharacteristicChanged

Added in API level 18

boolean notifyCharacteristicChanged (BluetoothDevice device, 
                BluetoothGattCharacteristic characteristic, 
                boolean confirm)

Send a notification or indication that a local characteristic has been updated.

A notification or indication is sent to the remote device to signal that the characteristic has been updated. This function should be invoked for every client that requests notifications/indications by writing to the "Client Configuration" descriptor for the given characteristic.

Requires BLUETOOTH permission.

Parameters
`device`	`BluetoothDevice`: The remote device to receive the notification/indication
`characteristic`	`BluetoothGattCharacteristic`: The local characteristic that has been updated
`confirm`	`boolean`: true to request confirmation from the client (indication), false to send a notification

Returns
`boolean`	true, if the notification has been triggered successfully

Throws
	IllegalArgumentException

removeService

Added in API level 18

boolean removeService (BluetoothGattService service)

Removes a service from the list of services to be provided.

Requires BLUETOOTH permission.

Parameters
`service`	`BluetoothGattService`: Service to be removed.

Returns
`boolean`	true, if the service has been removed

sendResponse

Added in API level 18

boolean sendResponse (BluetoothDevice device, 
                int requestId, 
                int status, 
                int offset, 
                byte[] value)

Send a response to a read or write request to a remote device.

This function must be invoked in when a remote read/write request is received by one of these callback methods:

Requires BLUETOOTH permission.

Parameters
`device`	`BluetoothDevice`: The remote device to send this response to
`requestId`	`int`: The ID of the request that was received with the callback
`status`	`int`: The status of the request to be sent to the remote devices
`offset`	`int`: Value offset for partial read/write response
`value`	`byte`: The value of the attribute that was read/written (optional)

Returns
`boolean`

Interfaces

Classes

Most visited

Recently visited

Results for

BluetoothGattServer

Summary

Inherited constants

Public methods

Inherited methods

Public methods

addService

cancelConnection

clearServices

close

connect

getConnectedDevices

getConnectionState

getDevicesMatchingConnectionStates

getService

getServices

notifyCharacteristicChanged

removeService

sendResponse