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

Executor

interface Executor<ID : Any> : Log.IdentifiableEmitter<ID>

An interface that provides methods to interact with the peripheral.

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

Properties

events

abstract val events: SharedFlow<GattEvent>

A flow of GATT events from the peripheral.

identifier

abstract val identifier: ID

initialServices

abstract val initialServices: List<RemoteService>

The initial services of the peripheral.

initialState

abstract val initialState: ConnectionState

The initial state of the peripheral.

isClosed

abstract val isClosed: Boolean

Returns true if the connection is closed.

isReliableWriteEnabled

abstract var isReliableWriteEnabled: Boolean

Returns true it reliable write is in progress.

logger

abstract var logger: Log.Sink<Layer>?

An object that will receive log events generated by the executor.

name

abstract val name: String?

The name of the device, if available.

Functions

abstract fun close()

Closes the connection to the peripheral.

connect

abstract suspend fun connect(autoConnect: Boolean, preferredPhy: List<Phy> = listOf(Phy.PHY_LE_1M))

Makes a connection to 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

Disconnects from the peripheral.

discoverServices

@IgnorableReturnValue

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

Initiates GATT services discovery.

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)

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)

readRssi

@IgnorableReturnValue

abstract suspend fun readRssi(): Boolean

Initiates a read of the RSSI value from the peripheral.

Relay

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

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)