commonMain.maryk.rocksdb.LRUCache.kt Maven / Gradle / Ivy

Go to download
package maryk.rocksdb

/** Least Recently Used Cache */
expect class LRUCache : Cache {
    /**
     * Create a new cache with a fixed size capacity. The cache is sharded
     * to 2^numShardBits shards, by hash of the key. The total capacity
     * is divided and evenly assigned to each shard.
     * numShardBits = -1 means it is automatically determined: every shard
     * will be at least 512KB and number of shard bits will not exceed 6.
     *
     * @param capacity The fixed size capacity of the cache
     * @param numShardBits The cache is sharded to 2^numShardBits shards,
     * by hash of the key
     */
    constructor(capacity: Long, numShardBits: Int)

    /**
     * Create a new cache with a fixed size capacity. The cache is sharded
     * to 2^numShardBits shards, by hash of the key. The total capacity
     * is divided and evenly assigned to each shard. If strictCapacityLimit
     * is set, insert to the cache will fail when cache is full.
     * numShardBits = -1 means it is automatically determined: every shard
     * will be at least 512KB and number of shard bits will not exceed 6.
     *
     * @param capacity The fixed size capacity of the cache
     * @param numShardBits The cache is sharded to 2^numShardBits shards,
     * by hash of the key
     * @param strictCapacityLimit insert to the cache will fail when cache is full
     */
    constructor(
        capacity: Long,
        numShardBits: Int,
        strictCapacityLimit: Boolean
    )

    /**
     * Create a new cache with a fixed size capacity. The cache is sharded
     * to 2^numShardBits shards, by hash of the key. The total capacity
     * is divided and evenly assigned to each shard. If strictCapacityLimit
     * is set, insert to the cache will fail when cache is full. User can also
     * set percentage of the cache reserves for high priority entries via
     * highPriPoolRatio.
     * numShardBits = -1 means it is automatically determined: every shard
     * will be at least 512KB and number of shard bits will not exceed 6.
     *
     * @param capacity The fixed size capacity of the cache
     * @param numShardBits The cache is sharded to 2^numShardBits shards,
     * by hash of the key
     * @param strictCapacityLimit insert to the cache will fail when cache is full
     * @param highPriPoolRatio percentage of the cache reserves for high priority
     * entries
     */
    constructor(
        capacity: Long, numShardBits: Int = -1,
        strictCapacityLimit: Boolean = false, highPriPoolRatio: Double = 0.0
    )
}