2.2.0

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

TorServiceConfig

open class TorServiceConfig(source)

Configuration info for producing TorRuntime.ServiceFactory to run tor within an android.app.Service.

NOTE: Only one TorServiceConfig instance can be instantiated. Successive invocations of Foreground.Companion.Builder or Companion.Builder will return the already created singleton instance.

e.g. (A Background Service)

val config = TorServiceConfig.Builder {
    // configure...
}

val environment = config.newEnvironment { resourceDir ->
    // Assuming use of `kmp-tor-resource` dependency, for example
    // the `exec` type.
    ResourceLoaderTorExec.getOrCreate(resourceDir)
}

val runtime = TorRuntime.Builder(environment) {
    // configure...
}

See also

TorServiceConfig.Companion.Builder

TorServiceConfig.Foreground.Companion.Builder

TorServiceConfig.newEnvironment

Inheritors

Types

open class BuilderScope

object Companion

class Foreground<C : AbstractTorServiceUI.Config, F : TorServiceUI.Factory<C, *, *>> : TorServiceConfig

An instance of TorServiceConfig which indicates to TorService that it should start itself as a Foreground Service.

protected object UTIL

Properties

stopServiceOnTaskRemoved

@JvmField

val stopServiceOnTaskRemoved: Boolean

See BuilderScope.stopServiceOnTaskRemoved

testUseBuildDirectory

@JvmField

val testUseBuildDirectory: Boolean

See BuilderScope.testUseBuildDirectory

useNetworkStateObserver

@JvmField

val useNetworkStateObserver: Boolean

See BuilderScope.useNetworkStateObserver

Functions

fun newEnvironment(loader: (File) -> ResourceLoader.Tor): TorRuntime.Environment

fun newEnvironment(loader: (File) -> ResourceLoader.Tor, block: ThisBlock<TorRuntime.Environment.BuilderScope>): TorRuntime.Environment

fun newEnvironment(dirName: String, loader: (File) -> ResourceLoader.Tor): TorRuntime.Environment

fun newEnvironment(dirName: String, loader: (File) -> ResourceLoader.Tor, block: ThisBlock<TorRuntime.Environment.BuilderScope>): TorRuntime.Environment

Android implementation which creates the TorRuntime.Environment using the provided TorServiceConfig.