bluetooth/server/com.splendo.kaluga.bluetooth.server

Package-level declarations

Types

data class AdvertiseData(val localName: String?, val serviceUUIDs: List<UUID>)

Identity of a local Bluetooth attribute (service, characteristic or descriptor), used to correlate a registered action with the matching incoming platform callback.

BaseBluetoothServerBuilder

interface BaseBluetoothServerBuilder

Builder class for creating a BluetoothServer.

BluetoothServer

interface BluetoothServer : AutoCloseable

A Bluetooth Server that makes the Hardware advertise AdvertiseData and exposes LocalService to connect to.

BluetoothServerBuilder

actual class BluetoothServerBuilder : BaseBluetoothServerBuilder

A default implementation of com.splendo.kaluga.bluetooth.server.BaseBluetoothServerBuilder

actual class BluetoothServerBuilder : BaseBluetoothServerBuilder

A default implementation of com.splendo.kaluga.bluetooth.server.BaseBluetoothServerBuilder

expect class BluetoothServerBuilder : BaseBluetoothServerBuilder

A default implementation of BaseBluetoothServerBuilder

BluetoothServerDSL

interface BluetoothServerDSL

Sets up a BluetoothServer

CapturedLocalService

class CapturedLocalService(val service: LocalService, val characteristicReads: Map<UUID, suspend LocalCharacteristic.(ConnectedDevice, Int) -> GattResponse.ReadResponse>, val characteristicWrites: Map<UUID, suspend LocalCharacteristic.(ConnectedDevice, ByteArray, Int) -> GattResponse.WriteResponse>, val descriptorReads: Map<UUID, suspend LocalDescriptor.(ConnectedDevice, Int) -> GattResponse.ReadResponse>, val descriptorWrites: Map<UUID, suspend LocalDescriptor.(ConnectedDevice, ByteArray, Int) -> GattResponse.WriteResponse>, val subscribableCharacteristics: Set<UUID>)

The result of buildCapturingLocalService, holding the built LocalService together with every read, write and subscription action captured while building it.

CBCharacteristicIdentity

value class CBCharacteristicIdentity(val characteristic: CBCharacteristic) : AttributeIdentity

CBServiceIdentity

value class CBServiceIdentity(val service: CBService) : AttributeIdentity

ConnectedDevice

actual interface ConnectedDevice : Device

A Device that connected to a BluetoothServer

actual interface ConnectedDevice : Device

A Device that connected to a BluetoothServer

expect interface ConnectedDevice : Device

A Device that connected to a BluetoothServer

DefaultBluetoothServer

class DefaultBluetoothServer : BluetoothServer, CoroutineScope

The default implementation of BluetoothServer. It makes the Hardware advertise AdvertiseData and exposes LocalService to connect to.

DefaultConnectedDevice

class DefaultConnectedDevice : ConnectedDevice

The default ConnectedDevice, wrapping the platform BluetoothDevice.

class DefaultConnectedDevice(val cbCentral: CBCentral) : ConnectedDevice

The default ConnectedDevice, wrapping the platform CBCentral.

DefaultLocalCharacteristicWrapper

class DefaultLocalCharacteristicWrapper(characteristic: BluetoothGattCharacteristic) : LocalCharacteristicWrapper

class DefaultLocalCharacteristicWrapper(characteristic: CBMutableCharacteristic) : LocalCharacteristicWrapper

DefaultLocalDescriptorWrapper

class DefaultLocalDescriptorWrapper(descriptor: BluetoothGattDescriptor) : LocalDescriptorWrapper

class DefaultLocalDescriptorWrapper : LocalDescriptorWrapper

DefaultLocalServiceWrapper

class DefaultLocalServiceWrapper(service: BluetoothGattService) : LocalServiceWrapper

class DefaultLocalServiceWrapper(service: CBMutableService) : LocalServiceWrapper

DefaultLocalServiceWrapperBuilder

class DefaultLocalServiceWrapperBuilder : LocalServiceWrapperBuilder

The LocalServiceWrapperBuilder backed by the Android Bluetooth framework.

class DefaultLocalServiceWrapperBuilder : LocalServiceWrapperBuilder

The LocalServiceWrapperBuilder backed by CoreBluetooth.

GattCharacteristicIdentity

@JvmInline

value class GattCharacteristicIdentity(val characteristic: BluetoothGattCharacteristic) : AttributeIdentity

GattDescriptorIdentity

@JvmInline

value class GattDescriptorIdentity(val descriptor: BluetoothGattDescriptor) : AttributeIdentity

GattServiceIdentity

@JvmInline

value class GattServiceIdentity(val service: BluetoothGattService) : AttributeIdentity

KalugaCBPeripheralManagerDelegate

class KalugaCBPeripheralManagerDelegate(logger: Logger, handlingContext: CoroutineContext) : NSObject, CBPeripheralManagerDelegateProtocol

LocalCharacteristic

sealed class LocalCharacteristic : Characteristic

A Characteristic available from a BluetoothServer

LocalCharacteristicWrapper

actual interface LocalCharacteristicWrapper

Accessor to the platform level Local Bluetooth characteristic.

actual interface LocalCharacteristicWrapper

Accessor to the platform level Local Bluetooth characteristic.

expect interface LocalCharacteristicWrapper

Accessor to the platform level Local Bluetooth characteristic.

LocalDescriptor

class LocalDescriptor(val wrapper: LocalDescriptorWrapper, val characteristic: LocalCharacteristic) : Descriptor

A Descriptor available from a BluetoothServer

LocalDescriptorWrapper

actual interface LocalDescriptorWrapper

Accessor to the platform level Local Bluetooth descriptor.

actual interface LocalDescriptorWrapper

Accessor to the platform level Local Bluetooth descriptor.

expect interface LocalDescriptorWrapper

Accessor to the platform level Local Bluetooth descriptor.

LocalService

class LocalService : Service

A Service available from a BluetoothServer

LocalServiceWrapper

actual interface LocalServiceWrapper

Accessor to the platform level Local Bluetooth service.

actual interface LocalServiceWrapper

Accessor to the platform level Local Bluetooth service.

expect interface LocalServiceWrapper

Accessor to the platform level Local Bluetooth service.

LocalServiceWrapperBuilder

interface LocalServiceWrapperBuilder

Creates the platform LocalServiceWrappers, LocalCharacteristicWrappers and LocalDescriptorWrappers for a LocalService graph. Injected into the DSL so tests can supply wrappers that don't require a live Bluetooth stack.

ServerSettings

data class ServerSettings(val permissions: Permissions, val autoRequestPermission: Boolean = true, val autoEnableBluetooth: Boolean = true, val logger: Logger = RestrictedLogger(RestrictedLogLevel.None))

Settings for configuring a BluetoothServer

ServerStatus

enum ServerStatus : Enum<ServerStatus>

The Status of a BluetoothServer

Functions

buildCapturingLocalService

fun buildCapturingLocalService(uuid: UUID, wrapperBuilder: LocalServiceWrapperBuilder, onNotify: suspend (LocalCharacteristic.Notifiable, ConnectedDevice, ByteArray) -> Boolean = { _, _, _ -> true }, service: LocalService.DSL.() -> Unit): CapturedLocalService

Test support builder that constructs a LocalService while capturing the per-attribute read and write actions and the subscribable characteristics into a CapturedLocalService.

readableAlwaysSuccess

inline fun <T : Any> LocalCharacteristic.DSL.readableAlwaysSuccess(encrypted: Boolean = false, bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline onRead: suspend LocalCharacteristic.(ConnectedDevice) -> T)

Makes this LocalCharacteristic readable by a com.splendo.kaluga.bluetooth.server.ConnectedDevice to always return GattResponse.ReadSuccess Cannot be called if LocalCharacteristic.DSL.readable, or LocalCharacteristic.DSL.readableAlwaysSuccess has been called before

inline fun <T : Any> LocalDescriptor.DSL.readableAlwaysSuccess(encrypted: Boolean = false, bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline onRead: suspend LocalDescriptor.(ConnectedDevice) -> T)

Makes this LocalDescriptor readable by a com.splendo.kaluga.bluetooth.server.ConnectedDevice to always return GattResponse.ReadSuccess Cannot be called if LocalDescriptor.DSL.readable, or LocalDescriptor.DSL.readableAlwaysSuccess has been called before

restoreBluetoothAdapterName

fun restoreBluetoothAdapterName(context: Context): Boolean

Restores the device's global Bluetooth adapter name if a previous BluetoothServer advertising session overrode it (to advertise a custom local name) and was interrupted—e.g. by a process kill—before it could restore it. BluetoothServer restoration is best-effort and runs on graceful teardown; call this to also repair a leak from a prior process, for example from Application.onCreate, when the app does not build a server on startup.

triggerNotification

fun LocalCharacteristic.DSL.NotificationDSL<ByteArray>.triggerNotification(properties: Set<CharacteristicProperty.Notifiable> = setOf(CharacteristicProperty.Notify), encrypted: Boolean = false)

Makes this LocalCharacteristic a LocalCharacteristic.Notifiable and automatically sends the ByteArray as a notification This method can only be called once.

inline fun <Trigger> LocalCharacteristic.DSL.NotificationDSL<Trigger>.triggerNotification(properties: Set<CharacteristicProperty.Notifiable> = setOf(CharacteristicProperty.Notify), encrypted: Boolean = false, bluetoothFormat: BluetoothFormat = BluetoothFormat)

Makes this LocalCharacteristic a LocalCharacteristic.Notifiable and automatically sends a ByteArray notification upon Trigger This method can only be called once.

writable

inline fun <T : Any> LocalDescriptor.DSL.writable(encrypted: Boolean = false, bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline onFailedToWrite: suspend LocalDescriptor.(ConnectedDevice, Exception) -> GattResponse.WriteResponse = { _, _ -> GattResponse.ApplicationError(0x80) }, noinline onWrite: suspend LocalDescriptor.(ConnectedDevice, T) -> GattResponse.WriteResponse)

Makes this LocalDescriptor writable by a com.splendo.kaluga.bluetooth.server.ConnectedDevice Cannot be called if LocalDescriptor.DSL.writable or LocalDescriptor.DSL.writableAlwaysSuccess has been called before

inline fun <T : Any> LocalCharacteristic.DSL.writable(properties: Set<CharacteristicProperty.Writable> = setOf(CharacteristicProperty.Write), encrypted: Boolean = false, bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline onFailedToWrite: suspend LocalCharacteristic.(ConnectedDevice, Exception) -> GattResponse.WriteResponse = { _, _ -> GattResponse.ApplicationError(0x80) }, noinline onWrite: suspend LocalCharacteristic.(ConnectedDevice, T) -> GattResponse.WriteResponse)

Makes this LocalCharacteristic writable by a com.splendo.kaluga.bluetooth.server.ConnectedDevice Cannot be called if writable has been called before

writableAlwaysSuccess

inline fun <T : Any> LocalDescriptor.DSL.writableAlwaysSuccess(encrypted: Boolean = false, bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline onWrite: suspend LocalDescriptor.(ConnectedDevice, T) -> Unit)

Makes this LocalDescriptor writable by a com.splendo.kaluga.bluetooth.server.ConnectedDevice and always responds with GattResponse.WriteSuccess.Acknowledged Cannot be called if LocalDescriptor.DSL.writable or LocalDescriptor.DSL.writableAlwaysSuccess has been called before

inline fun <T : Any> LocalCharacteristic.DSL.writableAlwaysSuccess(properties: Set<CharacteristicProperty.Writable> = setOf(CharacteristicProperty.Write), encrypted: Boolean = false, bluetoothFormat: BluetoothFormat = BluetoothFormat, noinline onWrite: suspend LocalCharacteristic.(ConnectedDevice, T) -> Unit)

Makes this LocalCharacteristic writable by a com.splendo.kaluga.bluetooth.server.ConnectedDevice and always responds with GattResponse.WriteSuccess.Acknowledged Cannot be called if writable has been called before