runtime-core/io.matthewnelson.kmp.tor.runtime.core

Package-level declarations

Types

Destroyable

interface Destroyable

Disposable

fun interface Disposable

A callback to return to callers to "undo", or "dispose" of something.

EnqueuedJob

abstract class EnqueuedJob(val name: String, onFailure: OnFailure, handler: UncaughtException.Handler)

Base abstraction for single-use model that tracks the state of a queue-able job. Once completed, either successfully or by cancellation/error, the EnqueuedJob is dead and should be discarded.

Event

abstract class Event<Data, E : Event<Data, E, O>, O : Event.Observer<Data, E>>(val name: String)

Base abstraction for creating enum like event/observer type hierarchies using kotlin sealed classes & data objects.

Executable

fun interface Executable

A callback for executing something

ItBlock

fun interface ItBlock<in It>

Helper for non-Kotlin consumers instead of using

OnEvent

fun interface OnEvent<in Data> : ItBlock<Data>

A callback for dispatching event data.

OnFailure

fun interface OnFailure : ItBlock<Throwable>

An alias of ItBlock indicating a callback for something occurring exceptionally.

OnSuccess

fun interface OnSuccess<in T> : ItBlock<T>

An alias of ItBlock indicating a callback for something occurring successfully.

ThisBlock

fun interface ThisBlock<in This : Any>

Helper for non-Kotlin consumers instead of using

TorEvent

sealed class TorEvent : Event<String, TorEvent, TorEvent.Observer>

Asynchronous Events

UncaughtException

class UncaughtException : RuntimeException

A special exception to indicate something went terribly wrong somewhere.

Functions

apply

inline fun <It> It.apply(block: ItBlock<It>): It

inline fun <This : Any> This.apply(block: ThisBlock<This>): This