normalized-cache/com.apollographql.cache.normalized.memory/MemoryCache

MemoryCache

class MemoryCache(nextCache: NormalizedCache? = null, maxSizeBytes: Int = Int.MAX_VALUE, expireAfterMillis: Long = -1) : NormalizedCache

Memory (multiplatform) cache implementation based on recently used property (LRU).

maxSizeBytes - the maximum size in bytes the cache may occupy. expireAfterMillis - after what timeout each entry in the cache treated as expired. By default there is no timeout.

Expired entries removed from the cache only on cache miss (loadRecord operation) and not removed from the cache automatically (there is no any sort of GC that runs in the background).

Constructors

MemoryCache

constructor(nextCache: NormalizedCache? = null, maxSizeBytes: Int = Int.MAX_VALUE, expireAfterMillis: Long = -1)

Functions

allRecords

suspend fun NormalizedCache.allRecords(): Map<CacheKey, Record>

clearAll

open suspend override fun clearAll()

Clears all records from the cache.

open suspend fun close()

dump

open suspend override fun dump(): Map<KClass<*>, Map<CacheKey, Record>>

garbageCollect

suspend fun NormalizedCache.garbageCollect(maxAgeProvider: MaxAgeProvider, maxStale: Duration = Duration.ZERO, clock: () -> Long = { currentTimeMillis() }): GarbageCollectResult

Perform garbage collection on the cache.

loadRecord

open suspend override fun loadRecord(key: CacheKey, cacheHeaders: CacheHeaders): Record?

loadRecords

open suspend override fun loadRecords(keys: Collection<CacheKey>, cacheHeaders: CacheHeaders): Collection<Record>

Calls through to NormalizedCache.loadRecord. Implementations should override this method if the underlying storage technology can offer an optimized manner to read multiple records. There is no guarantee on the order of returned Record

merge

open suspend override fun merge(record: Record, cacheHeaders: CacheHeaders, recordMerger: RecordMerger): Set<String>

open suspend override fun merge(records: Collection<Record>, cacheHeaders: CacheHeaders, recordMerger: RecordMerger): Set<String>

Calls through to NormalizedCache.merge. Implementations should override this method if the underlying storage technology can offer an optimized manner to store multiple records.

remove

open suspend override fun remove(cacheKey: CacheKey, cascade: Boolean): Boolean

Remove a record and potentially its referenced records from this cache and all chained caches

open suspend override fun remove(cacheKeys: Collection<CacheKey>, cascade: Boolean): Int

Calls through to NormalizedCache.remove. Implementations should override this method if the underlying storage technology can offer an optimized manner to remove multiple records.

removeDanglingReferences

suspend fun NormalizedCache.removeDanglingReferences(): RemovedFieldsAndRecords

Remove all dangling references in the cache. A field is a dangling reference if its value (or, for lists, any of its values) is a reference to a record that does not exist.

removeStaleFields

suspend fun NormalizedCache.removeStaleFields(maxAgeProvider: MaxAgeProvider, maxStale: Duration = Duration.ZERO, clock: () -> Long = { currentTimeMillis() }): RemovedFieldsAndRecords

Remove all stale fields in the cache. A field is stale if its received date is older than its max age (configurable via maxAgeProvider) or if its expiration date has passed. A maximum staleness can be passed.

removeUnreachableRecords

suspend fun NormalizedCache.removeUnreachableRecords(): Set<CacheKey>

Remove all unreachable records in the cache. A record is unreachable if there exists no chain of references from the root record to it.

sizeOfRecord

open override fun sizeOfRecord(record: Record): Int

Returns the size in bytes of a Record. This is an optional operation that can be implemented by the caches for debug purposes, otherwise it defaults to -1, meaning unknown size.

trim

open suspend override fun trim(maxSizeBytes: Long, trimFactor: Float): Long

Trims the cache if its size exceeds maxSizeBytes. The amount of data to remove is determined by trimFactor. The oldest records are removed according to their updated date.