public class GattService

Object
GattService

A service discovered on a remote GATT server via BlePeripheral.discoverServices(). Groups the GattCharacteristics the peripheral exposes.

Instances are constructed by the port during service discovery; application code never creates them.

Constructors

public GattService(BlePeripheral peripheral, BluetoothUuid uuid, boolean primary, int instanceId) Constructed by ports during service discovery; not application API.

Methods

`public` `BluetoothUuid getUuid()`	The UUID identifying this service.
`public boolean isPrimary()`	`true` for a primary service, `false` for a secondary one.
`public int getInstanceId()`	Disambiguates multiple instances of the same service UUID on one peripheral.
`public` `BlePeripheral getPeripheral()`	The peripheral this service belongs to.
`public` `List<GattCharacteristic> getCharacteristics()`	The characteristics of this service, in discovery order.
`public` `GattCharacteristic getCharacteristic(BluetoothUuid uuid)`	The first characteristic with the given UUID, or `null` when the service has none.
`public` `List<GattService> getIncludedServices()`	Secondary services included by this service; usually empty.
`public void addCharacteristic(GattCharacteristic characteristic)`	Called by ports while building the discovered GATT database; not application API.
`public void addIncludedService(GattService service)`	Called by ports while building the discovered GATT database; not application API.
`public` `String toString()`	Returns a string representation of the object.

Inherited methods

From Object

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

Constructor details

GattService

public GattService(BlePeripheral peripheral, BluetoothUuid uuid, boolean primary, int instanceId)

Constructed by ports during service discovery; not application API.

Method details

getUuid

public BluetoothUuid getUuid()

The UUID identifying this service.

isPrimary

public boolean isPrimary()

true for a primary service, false for a secondary one.

getInstanceId

public int getInstanceId()

Disambiguates multiple instances of the same service UUID on one peripheral.

getPeripheral

public BlePeripheral getPeripheral()

The peripheral this service belongs to.

getCharacteristics

public List<GattCharacteristic> getCharacteristics()

The characteristics of this service, in discovery order.

getCharacteristic

public GattCharacteristic getCharacteristic(BluetoothUuid uuid)

The first characteristic with the given UUID, or null when the service has none.

getIncludedServices

public List<GattService> getIncludedServices()

Secondary services included by this service; usually empty.

addCharacteristic

public void addCharacteristic(GattCharacteristic characteristic)

Called by ports while building the discovered GATT database; not application API.

addIncludedService

public void addIncludedService(GattService service)

Called by ports while building the discovered GATT database; not application API.

toString

public String toString()

Returns a string representation of the object. In general, the toString method returns a string that “textually represents” this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@’, and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + ‘@’ + Integer.toHexString(hashCode())