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

Binder

@ExperimentalKmpTorApi
interface Binder : RuntimeEvent.Notifier, FileID(source)

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

See also

Properties

Link copied to clipboard
abstract val fid: String

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

Link copied to clipboard
@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

Link copied to clipboard
@JvmStatic
fun RuntimeEvent.Notifier.d(from: Any?, log: String)

LOG.DEBUG level logging. Will prefix log with from string value and a space (' '), if from is non-null.

Link copied to clipboard
@JvmStatic
fun RuntimeEvent.Notifier.e(cause: Throwable)

ERROR level logging.

Link copied to clipboard
@JvmStatic
fun RuntimeEvent.Notifier.i(from: Any?, log: String)

LOG.INFO level logging. Will prefix log with from string value and a space (' '), if from is non-null.

Link copied to clipboard
@JvmStatic
fun RuntimeEvent.Notifier.lce(event: Lifecycle.Event)

LIFECYCLE event logging.

Link copied to clipboard
abstract fun <Data : Any, E : RuntimeEvent<Data>> notify(event: E, data: Data)
Link copied to clipboard
abstract fun onBind(serviceEvents: Set<TorEvent>, serviceObserverNetwork: NetworkObserver?, serviceObserversTorEvent: Set<TorEvent.Observer>, serviceObserversRuntimeEvent: Set<RuntimeEvent.Observer<*>>): Lifecycle.DestroyableTorRuntime

Meant to be called within the service object instance after startService has successfully executed, and ServiceFactory.binder has been injected into it.

Link copied to clipboard
@JvmStatic
@JvmOverloads
@JvmName(name = "fidString")
fun FileID.toFIDString(defaultClassName: String = "Unknown", includeHashCode: Boolean = true): String

Helper for overriding a class's toString function.

Link copied to clipboard
@JvmStatic
fun RuntimeEvent.Notifier.w(from: Any?, log: String)

LOG.WARN level logging. Will prefix log with from string value and a space (' '), if from is non-null.