Package-level declarations

Types

Link copied to clipboard
data class ClientIdentifier(val value: UUID)

This class identifies a connected client (smartphone) on a remote device uniquely during an active connection.

Link copied to clipboard

Enum which defines the implemented connection types over which data can be sent. Currently this is BLE (Bluetooth Low Energy), or WIFI (using MQTT).

Link copied to clipboard
abstract class FileTopic(path: String) : Topic<Nothing>

Defines a Topic which is used to transmit files between the SOComm device and the outside SDK (in both directions).

Link copied to clipboard
abstract class SOContext(val name: String, val connectionType: ConnectionType, val inTopics: Iterable<TopicIn<*>>, val outTopics: Iterable<TopicOut<*>>, val fileTopics: Iterable<FileTopic> = emptyList())

Defines a context to be used / released within the SDK.

Link copied to clipboard
abstract class Topic<T>(val path: String, val isRetained: Boolean)

Defines a Topic which can be subscribed to and/or published to.

Link copied to clipboard
abstract class TopicIn<T>(path: String) : Topic<T>

Defines a Topic which is used to transmit data from an outside SDK client to the SOComm device.

Link copied to clipboard
abstract class TopicOut<T>(path: String, isRetained: Boolean) : Topic<T>

Defines a Topic which is used to transmit data from the SOComm device to an outside SDK client.