yorkie/dev.yorkie.document.change/ChangeID

ChangeID

data class ChangeID(val clientSeq: UInt, val lamport: Long, val actor: ActorID, val versionVector: VersionVector, val serverSeq: Long = 0)

Identifies the Change.

Parameters

clientSeq

: is the sequence number of the client that created this change.

lamport

: lamport` is the lamport clock of this change. This is used to determine the order of changes in logical time. It is optional and only present if the change has operations.

actor

: is the creator of this change.

versionVector

: is the vector clock of this change. This is used to determine the relationship is causal or not between changes. It is optional and only present if the change has operations.

serverSeq

: is optional and only present for changes stored on the server.

Constructors

constructor(clientSeq: UInt, lamport: Long, actor: ActorID, versionVector: VersionVector, serverSeq: Long = 0)

Types

object Companion

Properties

val actor: ActorID

val clientSeq: UInt

val lamport: Long

val serverSeq: Long = 0

val versionVector: VersionVector

Functions

createTimeTicket

fun createTimeTicket(delimiter: UInt): TimeTicket

Creates a ticket of the given delimiter.

fun next(excludeClocks: Boolean = false): ChangeID

Creates a next ID of this ID.

fun setActor(actorID: ActorID): ChangeID

Sets the given actorID.

fun setClocks(otherLamport: Long, vector: VersionVector): ChangeID

setClocks sets the given clocks to this ID. This is used when the snapshot is given from the server.

fun setLamport(lamport: Long): ChangeID

setLamport sets the given lamport clock.

setVersionVector

fun setVersionVector(vector: VersionVector): ChangeID

Sets the vector vector.

fun syncClocks(other: ChangeID): ChangeID

syncClocks syncs logical clocks with the given ID.

fun syncLamport(otherLamport: Long): ChangeID

Syncs lamport timestamp with the given ID.