client-core-android/no.nordicsemi.kotlin.ble.client.android/Peripheral/Executor

Executor

interface Executor : Peripheral.Executor<String>

An interface that provides methods to interact with the peripheral.

The implementation should initiate requests and report events using events flow.

Properties

address

open val address: String

MAC address of the device.

bondState

abstract val bondState: StateFlow<BondState>

Bonding state as a state flow.

events

abstract val events: SharedFlow<GattEvent>

identifier

abstract val identifier: String

initialServices

abstract val initialServices: List<RemoteService>

initialState

abstract val initialState: ConnectionState

isClosed

abstract val isClosed: Boolean

isReliableWriteEnabled

abstract var isReliableWriteEnabled: Boolean

name

abstract val name: String?

type

abstract val type: PeripheralType

The Bluetooth device type of the remote device.

Functions

abortReliableWrite

@IgnorableReturnValue

abstract suspend fun abortReliableWrite(): Boolean

This method should abort a reliable write transaction.

beginReliableWrite

@IgnorableReturnValue

abstract fun beginReliableWrite(): Boolean

This method should initiate a reliable write transaction.

abstract fun close()

connect

abstract suspend fun connect(autoConnect: Boolean, preferredPhy: List<Phy>)

createBond

@IgnorableReturnValue

abstract suspend fun createBond(): Boolean

This method should initiate bonding with the peripheral.

disconnect

@IgnorableReturnValue

abstract suspend fun disconnect(): Boolean

discoverServices

@IgnorableReturnValue

abstract suspend fun discoverServices(uuids: List<Uuid>): Boolean

executeReliableWrite

@IgnorableReturnValue

abstract suspend fun executeReliableWrite(): Boolean

This method should execute all queued reliable write operations.

readPhy

@IgnorableReturnValue

abstract suspend fun readPhy(): Boolean

This method should initiate reading the current PHY parameters.

readRssi

@IgnorableReturnValue

abstract suspend fun readRssi(): Boolean

refreshCache

@IgnorableReturnValue

abstract suspend fun refreshCache(): Boolean

Refreshes services cache.

removeBond

@IgnorableReturnValue

abstract suspend fun removeBond(): Boolean

This method should initiate removing bond information associated with the peripheral.

requestConnectionPriority

@IgnorableReturnValue

abstract suspend fun requestConnectionPriority(priority: ConnectionPriority): Boolean

Requests the connection priority to be changed.

requestMtu

@IgnorableReturnValue

abstract suspend fun requestMtu(mtu: @Range(from = 23, to = 517) Int): Boolean

Requests the MTU (Maximum Transmission Unit) to be set to the given value.

requestPhy

@IgnorableReturnValue

abstract suspend fun requestPhy(txPhy: Phy, rxPhy: Phy, phyOptions: PhyOption): Boolean

Requests the PHY to be changed.