kvs-core/com.santimattius.kvs/KvsExtended

KvsExtended

interface KvsExtended : KvsStandard, KvsStream

Extended key-value storage interface with Time-To-Live (TTL) support.

KvsExtended augments the base KVS contract with the ability to associate an expiry Duration with individual entries. Expired entries are swept by the background CleanupJob returned from cleanupJob.

This interface is experimental and guarded by ExperimentalKvsTtl. Opt in with @OptIn(ExperimentalKvsTtl::class) or the compiler flag -opt-in=com.santimattius.kvs.ExperimentalKvsTtl.

See also

KvsExtended.KvsExtendedEditor

ExperimentalKvsTtl

Types

KvsExtendedEditor

interface KvsExtendedEditor

Builder for applying a batch of write operations with optional TTL to the store.

Functions

abstract fun cleanupJob(interval: Duration): CleanupJob

Returns a CleanupJob that, when started, periodically scans the store and removes entries whose TTL has elapsed.

abstract suspend operator fun contains(key: String): Boolean

Returns true if an entry with the given key exists and has not expired.

abstract fun edit(): KvsExtended.KvsExtendedEditor

Returns a new KvsExtendedEditor for staging write operations with optional TTL.

abstract suspend fun getAll(): Map<String, Any>

Returns all key-value entries currently held in the store.

abstract fun getAllAsStream(): Flow<Map<String, Any>>

Returns a Flow that emits the full store snapshot on every change.

abstract suspend fun getBoolean(key: String, defValue: Boolean): Boolean

Reads the Boolean value stored under key, returning defValue if absent.

getBooleanAsStream

abstract fun getBooleanAsStream(key: String, defValue: Boolean): Flow<Boolean>

Returns a Flow of the Boolean value stored under key.

abstract suspend fun getFloat(key: String, defValue: Float): Float

Reads the Float value stored under key, returning defValue if absent.

getFloatAsStream

abstract fun getFloatAsStream(key: String, defValue: Float): Flow<Float>

Returns a Flow of the Float value stored under key.

abstract suspend fun getInt(key: String, defValue: Int): Int

Reads the Int value stored under key, returning defValue if absent.

abstract fun getIntAsStream(key: String, defValue: Int): Flow<Int>

Returns a Flow of the Int value stored under key.

abstract suspend fun getLong(key: String, defValue: Long): Long

Reads the Long value stored under key, returning defValue if absent.

getLongAsStream

abstract fun getLongAsStream(key: String, defValue: Long): Flow<Long>

Returns a Flow of the Long value stored under key.

abstract suspend fun getString(key: String, defValue: String): String

Reads the String value stored under key, returning defValue if absent.

getStringAsStream

abstract fun getStringAsStream(key: String, defValue: String): Flow<String>

Returns a Flow of the String value stored under key.