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

Observer

abstract class Observer<Data, E : Event<Data, E, *>>(val event: E, tag: String?, executor: OnEvent.Executor?, onEvent: OnEvent<Data>)(source)

Base abstraction for creating event observer types.

Parameters

event

The event being observed.

tag

A string to help grouping/identifying observer(s).

executor

The thread context in which onEvent will be invoked in. If null, the default passed to notify from the Event processor implementation will be utilized.

onEvent

The callback to pass event data to.

Inheritors

Constructors

Link copied to clipboard
protected constructor(event: E, tag: String?, executor: OnEvent.Executor?, onEvent: OnEvent<Data>)

Properties

Link copied to clipboard
@JvmField
val event: E
Link copied to clipboard
@JvmField
val tag: String?

A string value for grouping or identifying the observer.

Functions

Link copied to clipboard
protected open fun notify(data: Data)

Optional override for inheritors to do things before invoking actual OnEvent callback (if at all) within the confines of the OnEvent.Executor context.

fun notify(default: OnEvent.Executor, data: Data)
fun notify(handler: CoroutineContext, default: OnEvent.Executor, data: Data)

Invokes OnEvent with the provided data

Link copied to clipboard
fun toString(isStatic: Boolean): String

Helper for processor implementations as to not expose a static tag externally.