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

SyncEventMessenger

class SyncEventMessenger<T : Event> : EventPublisher<T> , EventChannel<T>

Synchronous messenger for generic events. It allows event publishing and also handles the subscription of event listeners.

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

Constructors

SyncEventMessenger

fun SyncEventMessenger()

Functions

open override fun publish(event: T)

Publishes an event of the given T type.

open override fun register(listener: EventListener<T>)

Registers EventListener which will be notified about published events.

open override fun unregister(listener: EventListener<T>)

Unregisters the given EventListener.

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): AutoCloseable

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.