runtime-service/io.matthewnelson.kmp.tor.runtime.service/TorServiceUI/Factory

Factory

abstract class Factory<C : AbstractTorServiceUI.Config, IS : AbstractTorServiceUI.InstanceState<C>, UI : TorServiceUI<C, IS>> @ExperimentalKmpTorApi constructor(defaultConfig: C, val info: TorServiceUI.NotificationInfo) : AbstractTorServiceUI.Factory<TorServiceUI.Args, C, IS, UI> (source)

Core androidMain abstraction for a Factory class which is responsible for instantiating new instances of TorServiceUI when requested by TorService.

NOTE: This is currently an ExperimentalKmpTorApi when extending to create your own implementation. Things may change (as the annotation states), so use at your own risk! Prefer using the stable implementation via the kmp-tor:runtime-service-ui dependency.

Implementations are encouraged to keep it as a subclass within, and use a private constructor for, their UI implementations.

See also

io.matthewnelson.kmp.tor.runtime.service.ui.KmpTorServiceUI.Factory

Constructors

Link copied to clipboard
@ExperimentalKmpTorApi
protected constructor(defaultConfig: C, info: TorServiceUI.NotificationInfo)

Properties

Link copied to clipboard
@Volatile
var debug: Boolean

Enable/disable RuntimeEvent.LOG.DEBUG messages for UI components.

Link copied to clipboard
@JvmField
val defaultConfig: C

The default Config to use if one was not specified when TorRuntime.Environment was instantiated.

Link copied to clipboard
@JvmField
val info: TorServiceUI.NotificationInfo

Functions

Link copied to clipboard
protected abstract fun createProtected(args: TorServiceUI.Args): UI

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

Link copied to clipboard
abstract fun validate(context: Context)

Called from TorServiceConfig.Foreground.Companion.Builder when creating a new instance of TorServiceConfig.Foreground.

Link copied to clipboard
abstract fun validateConfig(context: Context, config: C)

Called from TorServiceConfig.Foreground.Companion.Builder and TorServiceConfig.Foreground.newEnvironment when checking the defaultConfig, or if a stand-alone Config is being used to create a new instance of TorRuntime.Environment.