RedisHttpCacheStore Class
Stores HTTP cache entries in Redis.
public sealed class RedisHttpCacheStore : IHttpCacheStore- Implements
Constructors
| Name | Description |
|---|---|
| RedisHttpCacheStore(IConnectionMultiplexer, string) | Initializes a new instance of the RedisHttpCacheStore class with no limit. |
| RedisHttpCacheStore(IConnectionMultiplexer, string, HttpCacheStoreLimits?) | Initializes a new instance of the RedisHttpCacheStore class that evicts the least recently used entries to stay within limits. |
RedisHttpCacheStore overloads
RedisHttpCacheStore(IConnectionMultiplexer, string)
RedisHttpCacheStore.csInitializes a new instance of the RedisHttpCacheStore class with no limit.
public RedisHttpCacheStore(IConnectionMultiplexer connectionMultiplexer, string keyPrefix = "Meziantou:HttpCache")Parameters
connectionMultiplexerIConnectionMultiplexer- The Redis connection multiplexer.
keyPrefixstring- The key prefix used to isolate cache entries in Redis.
RedisHttpCacheStore(IConnectionMultiplexer, string, HttpCacheStoreLimits?)
RedisHttpCacheStore.csInitializes a new instance of the RedisHttpCacheStore class that evicts the least recently used entries to stay within limits.
public RedisHttpCacheStore(IConnectionMultiplexer connectionMultiplexer, string keyPrefix, HttpCacheStoreLimits? limits)Parameters
connectionMultiplexerIConnectionMultiplexer- The Redis connection multiplexer.
keyPrefixstring- The key prefix used to isolate cache entries in Redis.
limitsHttpCacheStoreLimits?- The bounds of the store, or
nullfor no limit. The values are read once, by the constructor.
Remarks
A bounded store updates its keys with Lua scripts. With Redis Cluster, the keys of the store must be in the same slot: use a key prefix with a hash tag, such as {MyApp}:HttpCache.
Methods
| Name | Description |
|---|---|
| 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.csGets 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
primaryKeystring- The primary cache key.
cancellationTokenCancellationToken- The cancellation token.
Returns
PruneObsoleteEntriesAsync overloads
PruneObsoleteEntriesAsync(DateTimeOffset, CancellationToken)
RedisHttpCacheStore.csRemoves 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
nowDateTimeOffset- The current time used to evaluate expiration.
cancellationTokenCancellationToken- The cancellation token.
Returns
PruneObsoleteEntriesAsync(CancellationToken)
RedisHttpCacheStore.csRemoves expired entries that cannot be reused when stale.
public ValueTask PruneObsoleteEntriesAsync(CancellationToken cancellationToken = default)RemoveEntriesAsync(string, CancellationToken)
RedisHttpCacheStore.csRemoves 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
primaryKeystring- The primary cache key.
cancellationTokenCancellationToken- The cancellation token.
Returns
SetEntryAsync(string, HttpCachePersistenceEntry, CancellationToken)
RedisHttpCacheStore.csAdds 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
primaryKeystring- The primary cache key.
entryHttpCachePersistenceEntry- The entry to store.
cancellationTokenCancellationToken- The cancellation token.