runtime-service/io.matthewnelson.kmp.tor.runtime.service/AbstractTorServiceUI

AbstractTorServiceUI

abstract class AbstractTorServiceUI<A : AbstractTorServiceUI.Args.UI, C : AbstractTorServiceUI.Config, IS : AbstractTorServiceUI.InstanceState<C>>(source)

Core commonMain abstraction which enables implementors the ability to create a fully customized notification for the running instances of TorRuntime as they operate within a service object.

This class' API is designed as follows:

Factory: To be used for all TorRuntime.ServiceFactory instances and injected into a service object upon service creation.

Context: SINGLETON

AbstractTorServiceUI: To be created via Factory.createProtected upon service start.

Context: SERVICE

InstanceState: To be created via AbstractTorServiceUI.createProtected for every instance of Lifecycle.DestroyableTorRuntime operating within the service object.

Context: INSTANCE

Throws

IllegalStateException

on instantiation if args were not those which were passed to Factory.createProtected. See Args.

Inheritors

TorServiceUI

Types

Args

sealed class Args

Core commonMain abstraction for passing platform specific arguments, in an encapsulated manner, when instantiating new instances of AbstractTorServiceUI components.

Companion

protected object Companion

Config

abstract class Config @ExperimentalKmpTorApi constructor(fields: Map<String, Any?>)

Core commonMain abstraction for holding UI customization input from consumers of kmp-tor-service.

Factory

abstract class Factory<A : AbstractTorServiceUI.Args.UI, C : AbstractTorServiceUI.Config, IS : AbstractTorServiceUI.InstanceState<C>, UI : AbstractTorServiceUI<A, C, IS>>

Core commonMain abstraction for a Factory class which is responsible for instantiating new instances of AbstractTorServiceUI when requested by the service object.

InstanceState

abstract class InstanceState<C : AbstractTorServiceUI.Config> @ExperimentalKmpTorApi constructor(args: AbstractTorServiceUI.Args.Instance) : FileID

Core commonMain abstraction for implementors to track changes via registration of RuntimeEvent.Observer and TorEvent.Observer for the instance of Lifecycle.DestroyableTorRuntime operating within the service object.

Properties

defaultConfig

@JvmField

protected val defaultConfig: C

The default Config that was defined for Factory.defaultConfig

displayed

@get:JvmName(name = "displayed")

protected val displayed: IS?

Returns the currently displayed InstanceState.

instanceStates

@get:JvmName(name = "instanceStates")

protected val instanceStates: Collection<IS>

All InstanceState currently operating within this UI "container".

serviceChildScope

@JvmField

protected val serviceChildScope: CoroutineScope

A CoroutineScope which is configured as a child to the service object's CoroutineScope which utilizes Dispatchers.Main

Functions

createProtected

protected abstract fun createProtected(args: AbstractTorServiceUI.Args.Instance): IS

Implementors MUST utilize args to instantiate a new instance of the InstanceState implementation. If args were not consumed by the returned instance of InstanceState, an exception will be thrown by createProtected.