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.

encryptionState

abstract val encryptionState: StateFlow<EncryptionState>

The state of the encryption of the link as a state flow.

environment

abstract override val environment: AndroidEnvironment

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

logger

abstract var logger: Log.Sink<Layer>?

name

abstract val name: String?

operationMutex

abstract val operationMutex: OperationMutex

type

abstract val type: PeripheralType

The Bluetooth device type of the remote device.

Functions

abortReliableWrite

abstract suspend fun abortReliableWrite(): Boolean

This method should abort a reliable write transaction.

beginReliableWrite

abstract fun beginReliableWrite(): Boolean

This method should initiate a reliable write transaction.

abstract fun close()

connect

abstract suspend fun connect(autoConnect: Boolean, autoMtu: Boolean, opportunistic: Boolean)

createBond

abstract suspend fun createBond(): Boolean

This method should initiate bonding with the peripheral.

open fun <C : Log.Category> Log.Sink<C>.d(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.d(category: C, throwable: Throwable?, message: () -> String)

debug

open fun <C : Log.Category> Log.Sink<C>.debug(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.debug(category: C, throwable: Throwable?, message: () -> String)

disconnect

@IgnorableReturnValue

abstract suspend fun disconnect(reason: ConnectionState.Disconnected.Reason): Boolean

discoverServices

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

open fun <C : Log.Category> Log.Sink<C>.e(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.e(category: C, throwable: Throwable?, message: () -> String)

error

open fun <C : Log.Category> Log.Sink<C>.error(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.error(category: C, throwable: Throwable?, message: () -> String)

executeReliableWrite

abstract suspend fun executeReliableWrite(): Boolean

This method should execute all queued reliable write operations.

open fun <C : Log.Category> Log.Sink<C>.i(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.i(category: C, throwable: Throwable?, message: () -> String)

info

open fun <C : Log.Category> Log.Sink<C>.info(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.info(category: C, throwable: Throwable?, message: () -> String)

log

open override fun <C : Log.Category> Log.Sink<C>.log(category: C, level: Log.Level, throwable: Throwable)

open override fun <C : Log.Category> Log.Sink<C>.log(category: C, level: Log.Level, throwable: Throwable?, message: () -> String)

readPhy

abstract suspend fun readPhy(): Boolean

This method should initiate reading the current PHY parameters.

readRssi

abstract suspend fun readRssi(): Boolean

refreshCache

abstract suspend fun refreshCache(): Boolean

Refreshes services cache.

Relay

open override fun <C : Log.Category> Relay(sink: () -> Log.Sink<C>?): Log.Sink<C>

removeBond

abstract suspend fun removeBond(): Boolean

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

repeatingAfterBonding

open suspend override fun <T> repeatingAfterBonding(request: suspend () -> T): T

Executes a GATT request, and repeats it once if the system did not, after bonding that was started because the link had to be authenticated or encrypted.

requestConnectionPriority

abstract suspend fun requestConnectionPriority(priority: ConnectionPriority): Boolean

Requests the connection priority to be changed.

requestMtu

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

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

Requests the PHY to be changed.

open fun <C : Log.Category> Log.Sink<C>.t(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.t(category: C, throwable: Throwable?, message: () -> String)

trace

open fun <C : Log.Category> Log.Sink<C>.trace(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.trace(category: C, throwable: Throwable?, message: () -> String)

open fun <C : Log.Category> Log.Sink<C>.v(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.v(category: C, throwable: Throwable?, message: () -> String)

verbose

open fun <C : Log.Category> Log.Sink<C>.verbose(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.verbose(category: C, throwable: Throwable?, message: () -> String)

open fun <C : Log.Category> Log.Sink<C>.w(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.w(category: C, throwable: Throwable?, message: () -> String)

warn

open fun <C : Log.Category> Log.Sink<C>.warn(category: C, throwable: Throwable)

open fun <C : Log.Category> Log.Sink<C>.warn(category: C, throwable: Throwable?, message: () -> String)