echo-core/io.github.alexandrepiveteau.echo.core.log/History

History

A History is a high-performance log of serialized events, which aggregate the events into a current value which is incrementally computed from the linear sequence of events.

Parameters

the type of the aggregate.

Types

OnValueUpdateListener

fun interface OnValueUpdateListener<in T>

A listener which may be used to observe some changes on the current value.

Functions

acknowledged

abstract fun acknowledged(): EventIdentifierArray

Returns an EventIdentifierArray with all the acknowledgements that have been issued by this MutableEventLog. This EventIdentifierArray only contains one EventIdentifier per SiteIdentifier.

contains

open operator fun contains(id: EventIdentifier): Boolean

Returns true if the event with the event with the given EventIdentifier is included in the EventLog, or if any event with the same SiteIdentifier and a higher SequenceNumber has already been integrated.

abstract fun contains(seqno: SequenceNumber, site: SiteIdentifier): Boolean

Returns true if the event with the event with the given SiteIdentifier is included in the EventLog, or if any event with the same SiteIdentifier and a higher SequenceNumber has already been integrated.

iterator

abstract operator fun iterator(): EventIterator

Returns an EventIterator. The retrieved EventIterator will start at the beginning of the EventLog, and should not be used anymore if the underlying EventLog is modified.

abstract fun iterator(site: SiteIdentifier): EventIterator

Returns an EventIterator specific to a single site. The retrieved EventIterator will start at the beginning of the EventLog, and should not be used anymore if the underlying EventLog is modified.

iteratorAtEnd

abstract fun iteratorAtEnd(): EventIterator

Returns an EventIterator. The retrieved EventIterator will start at the end of the EventLog, and should not be used anymore if the underlying EventLog is modified.

abstract fun iteratorAtEnd(site: SiteIdentifier): EventIterator

Returns an EventIterator specific to a single site. The retrieved EventIterator will start at the end of the EventLog, and should not be used anymore if the underlying EventLog is modified.