runtime/io.matthewnelson.kmp.tor.runtime/TorRuntime/ServiceFactory

ServiceFactory

@ExperimentalKmpTorApi

abstract class ServiceFactory(initializer: TorRuntime.ServiceFactory.Initializer) : TorRuntime(source)

An instance of TorRuntime that produces Lifecycle.DestroyableTorRuntime under the hood which are intended to be run within a service object.

NOTE: This and its subclasses are currently marked as ExperimentalKmpTorApi. Things may change (as the annotation states), so use at your own risk! Prefer using the stable implementation via the kmp-tor:runtime-service dependency.

Constructors

ServiceFactory

protected constructor(initializer: TorRuntime.ServiceFactory.Initializer)

Types

Binder

@ExperimentalKmpTorApi

interface Binder : RuntimeEvent.Notifier, FileID

Helper for service objects to bind to the ServiceFactory by creating an instance of Lifecycle.DestroyableTorRuntime.

Initializer

@ExperimentalKmpTorApi

class Initializer

Single use class for initializing ServiceFactory. Multiples uses will result in IllegalStateException as the ServiceFactory implementation is held as a singleton for the given Environment that it belongs to.

Loader

@ExperimentalKmpTorApi

abstract class Loader

Helper for loading the implementation of ServiceFactory.

Properties

binder

@JvmField

protected val binder: TorRuntime.ServiceFactory.Binder

fid

override val fid: String

An ID string which is based off of a file path.

fidEllipses

@get:JvmStatic

@get:JvmName(name = "fidEllipses")

val FileID.fidEllipses: String

Returns the first and last 4 characters of the fid concatenated together with an ellipses between.

Functions

clearObservers

override fun clearObservers()

enqueue

override fun enqueue(action: Action, onFailure: OnFailure, onSuccess: OnSuccess<Unit>): EnqueuedJob

Enqueues the Action for execution.

override fun <Success : Any> enqueue(cmd: TorCmd.Unprivileged<Success>, onFailure: OnFailure, onSuccess: OnSuccess<Success>): EnqueuedJob

environment

override fun environment(): TorRuntime.Environment

Returns the current Environment for this TorRuntime instance.

isReady

override fun isReady(): Boolean

Checks if the tor process backing TorRuntime (if it is running) has completed starting up.

listeners

override fun listeners(): TorListeners

Returns the current TorListeners of this TorRuntime instance.

observeSignalNewNym

@JvmStatic

fun RuntimeEvent.Processor.observeSignalNewNym(tag: String?, executor: OnEvent.Executor?, onEvent: OnEvent<String?>): Disposable.Once

Subscribes with provided TorRuntime a CMD observer which will intercept execution of all TorCmd.Signal.NewNym jobs in order to transform tor's generic server response of Reply.Success.OK.

startService

protected abstract fun startService()

Called when Action.StartDaemon or Action.RestartDaemon has been enqueued and an instance of Lifecycle.DestroyableTorRuntime does not currently exist for this ServiceFactory.

state

override fun state(): TorState

Returns the current TorState of this TorRuntime instance.