common:core/com.tomtom.sdk.common.event/EventChannel

EventChannel

interface EventChannel<out T : Event>

Generic event channel that allows registration of listeners that will be called when an event is published via an appropriate EventPublisher.

Important: This is a Public Preview API. It may be changed or removed at any time.

Functions

abstract fun register(listener: EventListener<T>)

Registers an EventListener which will be notified about published events.

abstract fun unregister(listener: EventListener<T>)

Unregisters the given EventListener.

Inheritors

AdaptationThreadEventMessenger

SyncEventMessenger

Extensions

suspend fun <T : Event> EventChannel<T>.awaitEvent(awaitedEvent: T): T

Waits till provided event appears in the EventChannel

registerOneShotListener

fun <T : Event> EventChannel<T>.registerOneShotListener(filter: (T) -> Boolean = { true }, block: (T) -> Unit): Disposable

Registers EventListener that will be called only one time and only when given condition is met. Optional filter can be used to make the listener triggered only for certain events based on provided criteria. By default, all events are accepted. Once the listener is triggered, it will remove itself from this EventChannel automatically.