Skip to content

IBlobCache interface

Defined in

Namespace: Akavache.Reactive Assembly: Akavache.Reactive.dll Full name: Akavache.Reactive.IBlobCache Modifiers: public abstract

Summary

IBlobCache is the core database interface, it is an interface describing an asynchronous persistent key-value store.

Applies to

net10.0, net10.0-maccatalyst26.0, net10.0-desktop1.0, net10.0-browserwasm1.0, net10.0-tvos26.0, net10.0-windows10.0.19041, net10.0-macos26.0, net10.0-ios26.0, net10.0-android36.0, net9.0, net9.0-tvos18.0, net9.0-macos15.0, net9.0-maccatalyst18.0, net9.0-windows10.0.19041, net9.0-ios18.0, net9.0-desktop1.0, net8.0, net8.0-windows10.0.19041, net8.0-ios18.0, net8.0-maccatalyst18.0, net8.0-macos15.0, net8.0-tvos18.0, net8.0-ios17.5, net8.0-maccatalyst17.5, net8.0-macos14.5, netstandard2.1, net481, net462, net471

Class hierarchy 
classDiagram
class IBlobCache
class IDisposable {
    <>
}
IDisposable <|.. IBlobCache

Implements: IDisposable

Properties

NameSummary
SerializerGets the serializer.
SchedulerGets the IScheduler used to defer operations. By default, this is BlobCache.TaskpoolScheduler.
ForcedDateTimeKindGets or sets the DateTimeKind handling for BSON readers to be forced.

Methods

NameSummary
InsertInserts the specified key/value pairs into the blob.
GetRetrieve a value from the key-value cache. If the key is not in the cache, this method should return an IObservable which OnError's with KeyNotFoundException.
GetAllGets a observable of key value pairs with the specified keys with their corresponding values.
GetAllKeysReturn all keys in the cache. Note that this method is normally for diagnostic / testing purposes, and that it is not guaranteed to be accurate with respect to in-flight...
GetCreatedAtGets a observable of key value pairs with the specified keys with their corresponding created DateTimeOffset if it's available.
FlushThis method guarantees that all in-flight inserts have completed and any indexes have been written to disk.
InvalidateRemove a key from the cache. If the key doesn't exist, this method should do nothing and return (not throw KeyNotFoundException).
InvalidateAllInvalidates all entries for the specified type.
VacuumThis method eagerly removes all expired keys from the blob cache, as well as does any cleanup operations that makes sense (Hint: on SQLite3 it does a Vacuum).
UpdateExpirationUpdates the expiration date for an existing cache entry without reading or writing the cached data. This is useful when a server returns a NotModified response and you want to extend the...

Extension members