RedisHttpCacheStore Class

Stores HTTP cache entries in Redis.

public sealed class RedisHttpCacheStore : IHttpCacheStore
Implements

Constructors

NameDescription
RedisHttpCacheStore(IConnectionMultiplexer, string)Initializes a new instance of the RedisHttpCacheStore class.

RedisHttpCacheStore(IConnectionMultiplexer, string)

RedisHttpCacheStore.cs

Initializes a new instance of the RedisHttpCacheStore class.

public RedisHttpCacheStore(IConnectionMultiplexer connectionMultiplexer, string keyPrefix = "Meziantou:HttpCache")

Parameters

connectionMultiplexer IConnectionMultiplexer
The Redis connection multiplexer.
keyPrefix string
The key prefix used to isolate cache entries in Redis.

Methods

NameDescription
GetEntriesAsync(string, CancellationToken)Gets all entries associated with a primary cache key.
PruneObsoleteEntriesAsync(DateTimeOffset, CancellationToken)Removes expired entries that cannot be reused when stale.
PruneObsoleteEntriesAsync(CancellationToken)Removes expired entries that cannot be reused when stale.
RemoveEntriesAsync(string, CancellationToken)Removes all entries associated with a primary cache key.
SetEntryAsync(string, HttpCachePersistenceEntry, CancellationToken)Adds or replaces a cache entry for a primary key.

GetEntriesAsync(string, CancellationToken)

RedisHttpCacheStore.cs

Gets all entries associated with a primary cache key.

net10.0

public ValueTask<IReadOnlyCollection<HttpCachePersistenceEntry>> GetEntriesAsync(string primaryKey, CancellationToken cancellationToken)

net11.0

public ValueTask<IReadOnlyCollection<HttpCachePersistenceEntry>> GetEntriesAsync(string primaryKey, CancellationToken cancellationToken)

Parameters

primaryKey string
The primary cache key.
cancellationToken CancellationToken
The cancellation token.

Returns

ValueTask<IReadOnlyCollection<HttpCachePersistenceEntry>>

PruneObsoleteEntriesAsync overloads

PruneObsoleteEntriesAsync(DateTimeOffset, CancellationToken)

RedisHttpCacheStore.cs

Removes expired entries that cannot be reused when stale.

net10.0

public ValueTask PruneObsoleteEntriesAsync(DateTimeOffset now, CancellationToken cancellationToken = default)

net11.0

public ValueTask PruneObsoleteEntriesAsync(DateTimeOffset now, CancellationToken cancellationToken = default)
Parameters
now DateTimeOffset
The current time used to evaluate expiration.
cancellationToken CancellationToken
The cancellation token.
Returns

ValueTask

PruneObsoleteEntriesAsync(CancellationToken)

RedisHttpCacheStore.cs

Removes expired entries that cannot be reused when stale.

public ValueTask PruneObsoleteEntriesAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken CancellationToken
The cancellation token.
Returns

ValueTask

RemoveEntriesAsync(string, CancellationToken)

RedisHttpCacheStore.cs

Removes all entries associated with a primary cache key.

net10.0

public ValueTask RemoveEntriesAsync(string primaryKey, CancellationToken cancellationToken)

net11.0

public ValueTask RemoveEntriesAsync(string primaryKey, CancellationToken cancellationToken)

Parameters

primaryKey string
The primary cache key.
cancellationToken CancellationToken
The cancellation token.

Returns

ValueTask

SetEntryAsync(string, HttpCachePersistenceEntry, CancellationToken)

RedisHttpCacheStore.cs

Adds or replaces a cache entry for a primary key.

net10.0

public ValueTask SetEntryAsync(string primaryKey, HttpCachePersistenceEntry entry, CancellationToken cancellationToken)

net11.0

public ValueTask SetEntryAsync(string primaryKey, HttpCachePersistenceEntry entry, CancellationToken cancellationToken)

Parameters

primaryKey string
The primary cache key.
entry HttpCachePersistenceEntry
The entry to store.
cancellationToken CancellationToken
The cancellation token.

Returns

ValueTask