InstanceState
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.
The primary objective of the InstanceState API is to observe the Lifecycle.DestroyableTorRuntime instance operating within the service object and react by updating some sort of stateful object (whatever that may be for the implementation), then notify the UI "container" via postStateChange that a change has occurred.
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.
Throws
on instantiation if args were not those which were passed to createProtected. See Args.
Properties
The config for this instance. If no config was expressed when setting up the TorRuntime.Environment, then Factory.defaultConfig was utilized.
A CoroutineScope which is configured as a child to the serviceChildScope.
The RuntimeEvent.Observers that will be added upon instantiation of Lifecycle.DestroyableTorRuntime.
The TorEvent.Observers that will be added upon instantiation of Lifecycle.DestroyableTorRuntime.
Functions
Notify RuntimeEvent.LOG.DEBUG observers for the running instance of Lifecycle.DestroyableTorRuntime.
Exported functionality of RuntimeEvent.EXECUTE.CMD.observeSignalNewNym with the running instance of Lifecycle.DestroyableTorRuntime.
Notifies the AbstractTorServiceUI that this instance had some sort of stateful change so that it may update the UI (if needed).
Retrieves an Action.Processor which will pipe actions to the running instance of Lifecycle.DestroyableTorRuntime.
Retrieves a TorCmd.Unprivileged.Processor which will pipe commands to the running instance of Lifecycle.DestroyableTorRuntime.