echo-core/io.github.alexandrepiveteau.echo.core.causality

Package io.github.alexandrepiveteau.echo.core.causality

Types

value class EventIdentifier : Comparable<EventIdentifier>

An EventIdentifier uniquely identifies events and their causality relationships in a distributed system. It offers the properties of a Lamport timestamp, with a unique site identifier for each client to disambiguate duplicate timestamps.

EventIdentifierArray

class EventIdentifierArray

An array of event identifiers. When targeting the JVM, instances of this class are represented as long[].

EventIdentifierIterator

abstract class EventIdentifierIterator : Iterator<EventIdentifier>

An Iterator that is specialized for EventIdentifier. On the JVM, the values will be represented as a long.

SequenceNumber

@JvmInline

value class SequenceNumber : Comparable<SequenceNumber>

A sequence number is a monotonically increasing value defined for a site. It can be seen as a logical timestamp.

SiteIdentifier

@JvmInline

value class SiteIdentifier : Comparable<SiteIdentifier>

A SiteIdentifier is a unique identifier amongst all the sites in a distributed system. Two sites are guaranteed to have different SiteIdentifier.

Functions

binarySearch

fun EventIdentifierArray.binarySearch( element: EventIdentifier, fromIndex: Int = 0, toIndex: Int = size): Int

Searches this EventIdentifierArray for the provided element using the binary search algorithm. The array is expected to be sorted, otherwise the result is undefined.

binarySearchBySite

fun EventIdentifierArray.binarySearchBySite( element: SiteIdentifier, fromIndex: Int = 0, toIndex: Int = size): Int

Searches this EventIdentifierArray for the provided element using the binary search algorithm. The array is expected to be sorted by site identifiers, otherwise the result is undefined.

copyInto

fun EventIdentifierArray.copyInto( destination: EventIdentifierArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size): EventIdentifierArray

Copies this array or its subrange into the destination array and returns that array.

EventIdentifier