yafrl-core/io.github.yafrl.timeline.debugging/EventLogger

EventLogger

interface EventLogger(source)

Interface allowing for custom implementations of yafrl's event logging capability to be injected into a Timeline.

yafrl provides an InMemory logger by default, but if desired a custom implementation can be used (e.x. to provide console logging, serialization of events, etc...)

Inheritors

Types

Link copied to clipboard
object Disabled : EventLogger

The default event logger -- does not log anything.

Link copied to clipboard
class InMemory : EventLogger

A simple in-memory event logger.

Functions

Link copied to clipboard
abstract fun logEvent(event: ExternalEvent)

Send an event to the log.

Link copied to clipboard
abstract fun reportEvents(): List<ExternalEvent>

Return the list of all currently logged events in-order.