Class AbpRedisCache

Inheritance

object

AbpRedisCache

Implements

ICacheSupportsMultipleItems

Namespace: Volo.Abp.Caching.StackExchangeRedis

Assembly: Volo.Abp.Caching.StackExchangeRedis.dll

Syntax

[DisableConventionalRegistration]
public class AbpRedisCache : RedisCache, ICacheSupportsMultipleItems

Constructors

AbpRedisCache(IOptions<RedisCacheOptions>)

Declaration

public AbpRedisCache(IOptions<RedisCacheOptions> optionsAccessor)

Parameters

Type	Name	Description
IOptions<RedisCacheOptions>	optionsAccessor

Fields

AbsoluteExpirationKey

Declaration

protected static readonly string AbsoluteExpirationKey

Field Value

Type	Description
string

DataKey

Declaration

protected static readonly string DataKey

Field Value

Type	Description
string

HashMembersAbsoluteExpirationSlidingExpiration

Declaration

protected static readonly RedisValue[] HashMembersAbsoluteExpirationSlidingExpiration

Field Value

Type	Description
RedisValue[]

HashMembersAbsoluteExpirationSlidingExpirationData

Declaration

protected static readonly RedisValue[] HashMembersAbsoluteExpirationSlidingExpirationData

Field Value

Type	Description
RedisValue[]

NotPresent

Declaration

protected static readonly long NotPresent

Field Value

Type	Description
long

SlidingExpirationKey

Declaration

protected static readonly string SlidingExpirationKey

Field Value

Type	Description
string

Properties

InstancePrefix

Declaration

protected RedisKey InstancePrefix { get; }

Property Value

Type	Description
RedisKey

Methods

Connect()

Declaration

protected virtual IDatabase Connect()

Returns

Type	Description
IDatabase

ConnectAsync(CancellationToken)

Declaration

protected virtual ValueTask<IDatabase> ConnectAsync(CancellationToken token = default)

Parameters

Type	Name	Description
CancellationToken	token

Returns

Type	Description
ValueTask<IDatabase>

GetAbsoluteExpiration(DateTimeOffset, DistributedCacheEntryOptions)

Declaration

protected virtual DateTimeOffset? GetAbsoluteExpiration(DateTimeOffset creationTime, DistributedCacheEntryOptions options)

Parameters

Type	Name	Description
DateTimeOffset	creationTime
DistributedCacheEntryOptions	options

Returns

Type	Description
DateTimeOffset?

GetAndRefreshMany(IEnumerable<string>, bool)

Declaration

protected virtual byte[]?[] GetAndRefreshMany(IEnumerable<string> keys, bool getData)

Parameters

Type	Name	Description
IEnumerable<string>	keys
bool	getData

Returns

Type	Description
byte[][]

GetAndRefreshManyAsync(IEnumerable<string>, bool, CancellationToken)

Declaration

protected virtual Task<byte[]?[]> GetAndRefreshManyAsync(IEnumerable<string> keys, bool getData, CancellationToken token = default)

Parameters

Type	Name	Description
IEnumerable<string>	keys
bool	getData
CancellationToken	token

Returns

Type	Description
Task<byte[][]>

GetExpirationInSeconds(DateTimeOffset, DateTimeOffset?, DistributedCacheEntryOptions)

Declaration

protected virtual long? GetExpirationInSeconds(DateTimeOffset creationTime, DateTimeOffset? absoluteExpiration, DistributedCacheEntryOptions options)

Parameters

Type	Name	Description
DateTimeOffset	creationTime
DateTimeOffset?	absoluteExpiration
DistributedCacheEntryOptions	options

Returns

Type	Description
long?

GetMany(IEnumerable<string>)

Declaration

public byte[]?[] GetMany(IEnumerable<string> keys)

Parameters

Type	Name	Description
IEnumerable<string>	keys

Returns

Type	Description
byte[][]

GetManyAsync(IEnumerable<string>, CancellationToken)

Declaration

public Task<byte[]?[]> GetManyAsync(IEnumerable<string> keys, CancellationToken token = default)

Parameters

Type	Name	Description
IEnumerable<string>	keys
CancellationToken	token

Returns

Type	Description
Task<byte[][]>

MapMetadata(RedisValue[], out DateTimeOffset?, out TimeSpan?)

Declaration

protected virtual void MapMetadata(RedisValue[] results, out DateTimeOffset? absoluteExpiration, out TimeSpan? slidingExpiration)

Parameters

Type	Name	Description
RedisValue[]	results
DateTimeOffset?	absoluteExpiration
TimeSpan?	slidingExpiration

OnRedisError(Exception, IDatabase)

Declaration

protected virtual void OnRedisError(Exception ex, IDatabase cache)

Parameters

Type	Name	Description
Exception	ex
IDatabase	cache

PipelineRefreshManyAndOutData(IDatabase, RedisKey[], RedisValue[][], out byte[]?[])

Declaration

protected virtual Task[] PipelineRefreshManyAndOutData(IDatabase cache, RedisKey[] keys, RedisValue[][] results, out byte[]?[] bytes)

Parameters

Type	Name	Description
IDatabase	cache
RedisKey[]	keys
RedisValue[][]	results
byte[][]	bytes

Returns

Type	Description
Task[]

PipelineSetMany(IDatabase, IEnumerable<KeyValuePair<string, byte[]>>, DistributedCacheEntryOptions)

Declaration

protected virtual Task[] PipelineSetMany(IDatabase cache, IEnumerable<KeyValuePair<string, byte[]>> items, DistributedCacheEntryOptions options)

Parameters

Type	Name	Description
IDatabase	cache
IEnumerable<KeyValuePair<string, byte[]>>	items
DistributedCacheEntryOptions	options

Returns

Type	Description
Task[]

RefreshMany(IEnumerable<string>)

Declaration

public void RefreshMany(IEnumerable<string> keys)

Parameters

Type	Name	Description
IEnumerable<string>	keys

RefreshManyAsync(IEnumerable<string>, CancellationToken)

Declaration

public Task RefreshManyAsync(IEnumerable<string> keys, CancellationToken token = default)

Parameters

Type	Name	Description
IEnumerable<string>	keys
CancellationToken	token

Returns

Type	Description
Task

RemoveMany(IEnumerable<string>)

Declaration

public void RemoveMany(IEnumerable<string> keys)

Parameters

Type	Name	Description
IEnumerable<string>	keys

RemoveManyAsync(IEnumerable<string>, CancellationToken)

Declaration

public Task RemoveManyAsync(IEnumerable<string> keys, CancellationToken token = default)

Parameters

Type	Name	Description
IEnumerable<string>	keys
CancellationToken	token

Returns

Type	Description
Task

SetMany(IEnumerable<KeyValuePair<string, byte[]>>, DistributedCacheEntryOptions)

Declaration

public void SetMany(IEnumerable<KeyValuePair<string, byte[]>> items, DistributedCacheEntryOptions options)

Parameters

Type	Name	Description
IEnumerable<KeyValuePair<string, byte[]>>	items
DistributedCacheEntryOptions	options

SetManyAsync(IEnumerable<KeyValuePair<string, byte[]>>, DistributedCacheEntryOptions, CancellationToken)

Declaration

public Task SetManyAsync(IEnumerable<KeyValuePair<string, byte[]>> items, DistributedCacheEntryOptions options, CancellationToken token = default)

Parameters

Type	Name	Description
IEnumerable<KeyValuePair<string, byte[]>>	items
DistributedCacheEntryOptions	options
CancellationToken	token

Returns

Type	Description
Task

Implements

ICacheSupportsMultipleItems

Extension Methods

AbpObjectExtensions.As<T>(object)

AbpObjectExtensions.To<T>(object)

LockExtensions.Locking(object, Action)

LockExtensions.Locking<TResult>(object, Func<TResult>)

AbpObjectExtensions.If<T>(T, bool, Action<T>)

AbpObjectExtensions.If<T>(T, bool, Func<T, T>)

AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)

AbpObjectExtensions.IsIn<T>(T, params T[])

AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)

AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)

AbpOpenIddictQueryableExtensions.SkipIf<T, TQueryable>(TQueryable, bool, int?)

AbpOpenIddictQueryableExtensions.TakeIf<T, TQueryable>(TQueryable, bool, int?)

LockExtensions.Locking<T>(T, Action<T>)

LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)