core/com.profilog.telemetry.devices/Connection

Connection

sealed class Connection<out TProgress, out TProperties, out TConnectionConfiguration, out TConnectionProvidedConfiguration>

Ongoing connection to a device.

TProgress model represents progress of connecting/loading data from device. Provided only for devices that support it.

TProperties model represents device properties (f.e. battery percent). Provided only for devices that support it.

TConnectionConfiguration model representing device connection configuration required for connection initialization. Provided only for devices that support it.

TConnectionProvidedConfiguration model representing device settings for connection initialization. Provided only for devices that support it.

Usual connection flow:

  1. Searching. Here it can appear BluetoothInvalidState or Timeout.

  2. Connecting.

  3. ConnectionConfiguration in case of device that supports it.

  4. Connected.

  5. Progress, Properties in case of device that supports it.

  6. DataLoaded.

  7. Disconnecting.

  8. Disconnected.

ConnectError in case of any communication error.

Inheritors

Types

Link copied to clipboard
data class BluetoothInvalidState(val bluetoothState: BluetoothState) : Connection<Nothing, Nothing, Nothing, Nothing>

Bluetooth state is invalid.

Link copied to clipboard
data object Connected : Connection<Nothing, Nothing, Nothing, Nothing>

Device is connected.

Link copied to clipboard
data object ConnectError : Connection<Nothing, Nothing, Nothing, Nothing>

Communication error.

Link copied to clipboard
data class Connecting(val uid: String) : Connection<Nothing, Nothing, Nothing, Nothing>

Device is being connected.

Link copied to clipboard
Link copied to clipboard
class DataLoaded(val data: List<Record>) : Connection<Nothing, Nothing, Nothing, Nothing>

Device has provided data.

Link copied to clipboard
data object Disconnected : Connection<Nothing, Nothing, Nothing, Nothing>

Device is disconnected.

Link copied to clipboard
data object Disconnecting : Connection<Nothing, Nothing, Nothing, Nothing>

Device is being disconnected.

Link copied to clipboard
class Progress<out TProgress>(val progress: TProgress) : Connection<TProgress, Nothing, Nothing, Nothing>

Device is providing data.

Link copied to clipboard
class Properties<out TProperties>(val properties: TProperties) : Connection<Nothing, TProperties, Nothing, Nothing>

Device is providing additional properties like battery percent, mode, etc.

Link copied to clipboard
data object Searching : Connection<Nothing, Nothing, Nothing, Nothing>

Searching for a device.

Link copied to clipboard
data object Timeout : Connection<Nothing, Nothing, Nothing, Nothing>

Device search timed out.

Link copied to clipboard
data class WaitingForResources(val availableAt: Instant) : Connection<Nothing, Nothing, Nothing, Nothing>

Waiting for system resources. Reports delay until system resources are available.

Properties

Link copied to clipboard
val Connection<*, *, *, *>.terminating: Boolean

Represents device connection terminating state. (Disconnected, ConnectError, Timeout, BluetoothInvalidState)