kuilt-bolt/us.tractat.kuilt.bolt

Package-level declarations

Types

data class Archived<Op>(val offset: Long, val endOffset: Long, val arrivedAt: Instant, val insertDots: Set<Dot>, val key: String?, val ops: List<Op>) : ReplayEvent<Op>

One archived frame.

ArchiveHealth

data class ArchiveHealth(val framesWritten: Long = 0, val opsArchived: Long = 0, val opsDeduplicated: Long = 0, val appendsFailed: Long = 0, val recentFailures: List<AppendResult.Failed> = emptyList(), val durability: DurabilityState = DurabilityState.AsPromised)

What a BoltDecorator has managed to archive, and — more importantly — what it has not.

Bolt

interface Bolt<Op>

A write-only archive for an op-log CRDT: operations flow in and never out.

BoltArchiveFormat

class BoltArchiveFormat<Id : Any, V, Op : Any>(classifier: OpLogCrdt<Id, V, Op>, vSerializer: KSerializer<V>)

How one op-log CRDT's operations are classified and encoded into an archive.

BoltAvailability

sealed interface BoltAvailability

Whether a Bolt can be written to on this runtime.

BoltDecorator

class BoltDecorator<Id : Any, V, Op : Any>(bolt: Bolt<Op>, format: BoltArchiveFormat<Id, V, Op>, removalWindow: Int = DEFAULT_REMOVAL_WINDOW, frontierWindow: Int = DEFAULT_FRONTIER_WINDOW)

Feeds a Bolt the operations a CRDT owner applied, and suppresses the ones it has already archived.

BoltFormatException

class BoltFormatException(message: String) : Exception

Thrown when archive bytes are not a bolt archive this build can read.

CleanTail

data object CleanTail : ReplayEvent<Nothing>

The replay reached the end of the archive with every frame in scope intact.

DurabilityState

sealed interface DurabilityState

Whether a Bolt is meeting the durability level it promised.

InMemoryBolt

class InMemoryBolt<Id : Any, V, Op : Any>(format: BoltArchiveFormat<Id, V, Op>, clock: Clock, segmentFrameBytes: Long = DEFAULT_SEGMENT_FRAME_BYTES, capacityBytes: Long = Long.MAX_VALUE) : Bolt<Op>

A Bolt whose segments live in memory — the reference implementation, and the one every target has, including the browser.

ReplayEvent

sealed interface ReplayEvent<out Op>

One element of a Bolt.replay stream: a frame, or the terminal verdict on how the stream ended.

ReplayScope

sealed interface ReplayScope

Which frames a Bolt.replay should yield.

Truncated

data class Truncated(val atOffset: Long, val reason: TruncationReason) : ReplayEvent<Nothing>

The replay stopped early: the archive is damaged, or was still being written, at atOffset.

TruncationReason

enum TruncationReason : Enum<TruncationReason>

Why a replay stopped early, in a Truncated verdict.

Properties

BOLT_FORMAT_VERSION

const val BOLT_FORMAT_VERSION: Int = 1

The archive format version written into every segment header.

Functions

frames

fun <Op> Flow<ReplayEvent<Op>>.frames(): Flow<Archived<Op>>

Just the frames, discarding the terminal verdict.