Log

interface Log<M> : AutoCloseable

Inheritors

InMemoryLog

LocalLog

Types

Companion

object Companion

Factory

interface Factory

MessageMetadata

class MessageMetadata(val epoch: Int, val logOffset: LogOffset, val logTimestamp: LogTimestamp)

MessageTooLargeException

class MessageTooLargeException(message: String, cause: Throwable? = null) : RuntimeException

Record

class Record<out M>(val epoch: Int, val logOffset: LogOffset, val logTimestamp: Instant, val message: M)

RecordProcessor

fun interface RecordProcessor<in M>

Registration

interface Registration

Tail

interface Tail<out M>

One consumer's position in a partition, valid only for the duration of withTail.

Properties

epoch

abstract val epoch: Int

Functions

appendMessage

abstract suspend fun appendMessage(message: M, partition: Int = 0): Log.MessageMetadata

appendMessageBlocking

open fun appendMessageBlocking(message: M, partition: Int = 0): Log.MessageMetadata

abstract fun close()

latestSubmittedMsgId

open fun latestSubmittedMsgId(partition: Int = 0): MessageId

latestSubmittedOffset

abstract fun latestSubmittedOffset(partition: Int = 0): LogOffset

readLastMessage

abstract fun readLastMessage(partition: Int = 0): M?

readRecords

abstract fun readRecords(partition: Int, fromMsgId: MessageId, toMsgId: MessageId): Sequence<Log.Record<M>>

Reads records in the range [fromMsgId, toMsgId) (start-inclusive, end-exclusive). Returns a lazy sequence of decoded records in offset order. If toMsgId exceeds the latest submitted offset, reads up to the latest available record.

tailAll

open suspend fun tailAll(partition: Int, afterMsgId: MessageId, pollTimeout: Duration = 1.seconds, processor: Log.RecordProcessor<M>)

Polls a tail until cancelled, handing every poll to processor, including empty polls.

withTail

abstract suspend fun <R> withTail(partition: Int, afterMsgId: MessageId, action: suspend (Log.Tail<M>) -> R): R

Runs action with a tail positioned after afterMsgId. The tail and its subscription are valid only until action returns.