Class RedisCacheHandle<TCacheValue>

    Cache handle implementation for Redis.

    Inheritance
    Object
    BaseCache<TCacheValue>
    BaseCacheHandle<TCacheValue>
    RedisCacheHandle<TCacheValue>
    Inherited Members
    Namespace:CacheManager.Redis
    Assembly:CacheManager.StackExchange.Redis.dll
    Syntax
    public class RedisCacheHandle<TCacheValue> : BaseCacheHandle<TCacheValue>, ICache<TCacheValue>, IDisposable
    Type Parameters
    Name Description
    TCacheValue

    The type of the cache value.

    Constructors

    | Improve this Doc View Source

    RedisCacheHandle(ICacheManagerConfiguration, CacheHandleConfiguration, ILoggerFactory, ICacheSerializer)

    Initializes a new instance of the RedisCacheHandle<TCacheValue> class.

    Declaration
    public RedisCacheHandle(ICacheManagerConfiguration managerConfiguration, CacheHandleConfiguration configuration, ILoggerFactory loggerFactory, ICacheSerializer serializer)
    Parameters
    Type Name Description
    ICacheManagerConfiguration managerConfiguration

    The manager configuration.
    CacheHandleConfiguration configuration

    The cache handle configuration.
    ILoggerFactory loggerFactory

    The logger factory.
    ICacheSerializer serializer

    The serializer.

    Properties

    | Improve this Doc View Source

    Count

    Gets the number of items the cache handle currently maintains.

    Declaration
    public override int Count { get; }
    Property Value
    Type Description
    Int32

    The count.
    Overrides
    CacheManager.Core.Internal.BaseCacheHandle<TCacheValue>.Count
    Exceptions
    Type Condition
    InvalidOperationException

    No active master found.
    | Improve this Doc View Source

    Features

    Gets the features the redis server supports.

    Declaration
    public RedisFeatures Features { get; }
    Property Value
    Type Description
    StackExchange.Redis.RedisFeatures

    The server features.
    | Improve this Doc View Source

    IsDistributedCache

    Declaration
    public override bool IsDistributedCache { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    CacheManager.Core.Internal.BaseCacheHandle<TCacheValue>.IsDistributedCache
    | Improve this Doc View Source

    IsLuaAllowed

    Gets a value indicating whether we can use the lua implementation instead of manual. This flag will be set automatically via feature detection based on the Redis server version or via StrictCompatibilityModeVersion if set to a version which does not support lua scripting.

    Declaration
    public bool IsLuaAllowed { get; }
    Property Value
    Type Description
    Boolean
    | Improve this Doc View Source

    Logger

    Declaration
    protected override ILogger Logger { get; }
    Property Value
    Type Description
    ILogger
    Overrides
    CacheManager.Core.Internal.BaseCache<TCacheValue>.Logger
    | Improve this Doc View Source

    Servers

    Gets the servers.

    Declaration
    public IEnumerable<IServer> Servers { get; }
    Property Value
    Type Description
    IEnumerable<StackExchange.Redis.IServer>

    The list of servers.

    Methods

    | Improve this Doc View Source

    AddInternalPrepared(CacheItem<TCacheValue>)

    Adds a value to the cache.

    Add call is synced, so might be slower than put which is fire and forget but we want to return true|false if the operation was successfully or not. And always returning true could be misleading if the item already exists

    Declaration
    protected override bool AddInternalPrepared(CacheItem<TCacheValue> item)
    Parameters
    Type Name Description
    CacheItem<TCacheValue> item

    The CacheItem to be added to the cache.
    Returns
    Type Description
    Boolean

    true if the key was not already added to the cache, false otherwise.
    Overrides
    CacheManager.Core.Internal.BaseCacheHandle<TCacheValue>.AddInternalPrepared(CacheManager.Core.CacheItem<TCacheValue>)
    | Improve this Doc View Source

    Clear()

    Clears this cache, removing all items in the base cache and all regions.

    Declaration
    public override void Clear()
    Overrides
    CacheManager.Core.Internal.BaseCache<TCacheValue>.Clear()
    | Improve this Doc View Source

    ClearRegion(String)

    Clears the cache region, removing all items from the specified region only.

    Declaration
    public override void ClearRegion(string region)
    Parameters
    Type Name Description
    String region

    The cache region.
    Overrides
    CacheManager.Core.Internal.BaseCache<TCacheValue>.ClearRegion(System.String)
    | Improve this Doc View Source

    Dispose(Boolean)

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Declaration
    protected override void Dispose(bool disposeManaged)
    Parameters
    Type Name Description
    Boolean disposeManaged

    Indicator if managed resources should be released.
    Overrides
    CacheManager.Core.Internal.BaseCacheHandle<TCacheValue>.Dispose(System.Boolean)
    | Improve this Doc View Source

    Exists(String)

    Declaration
    public override bool Exists(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Boolean
    Overrides
    CacheManager.Core.Internal.BaseCache<TCacheValue>.Exists(System.String)
    | Improve this Doc View Source

    Exists(String, String)

    Declaration
    public override bool Exists(string key, string region)
    Parameters
    Type Name Description
    String key
    String region
    Returns
    Type Description
    Boolean
    Overrides
    CacheManager.Core.Internal.BaseCache<TCacheValue>.Exists(System.String, System.String)
    | Improve this Doc View Source

    GetCacheItemInternal(String)

    Gets a CacheItem for the specified key.

    Declaration
    protected override CacheItem<TCacheValue> GetCacheItemInternal(string key)
    Parameters
    Type Name Description
    String key

    The key being used to identify the item within the cache.
    Returns
    Type Description
    CacheItem<TCacheValue>

    The CacheItem.
    Overrides
    CacheManager.Core.Internal.BaseCache<TCacheValue>.GetCacheItemInternal(System.String)
    | Improve this Doc View Source

    GetCacheItemInternal(String, String)

    Gets a CacheItem for the specified key.

    Declaration
    protected override CacheItem<TCacheValue> GetCacheItemInternal(string key, string region)
    Parameters
    Type Name Description
    String key

    The key being used to identify the item within the cache.
    String region

    The cache region.
    Returns
    Type Description
    CacheItem<TCacheValue>

    The CacheItem.
    Overrides
    CacheManager.Core.Internal.BaseCache<TCacheValue>.GetCacheItemInternal(System.String, System.String)
    | Improve this Doc View Source

    GetCacheItemInternalNoScript(String, String)

    Declaration
    protected CacheItem<TCacheValue> GetCacheItemInternalNoScript(string key, string region)
    Parameters
    Type Name Description
    String key
    String region
    Returns
    Type Description
    CacheItem<TCacheValue>
    | Improve this Doc View Source

    PutInternal(CacheItem<TCacheValue>)

    Puts the item into the cache. If the item exists it will get updated with the new value. If the item doesn't exist, the item will be added to the cache.

    Declaration
    protected override void PutInternal(CacheItem<TCacheValue> item)
    Parameters
    Type Name Description
    CacheItem<TCacheValue> item

    The CacheItem to be added to the cache.
    Overrides
    CacheManager.Core.Internal.BaseCacheHandle<TCacheValue>.PutInternal(CacheManager.Core.CacheItem<TCacheValue>)
    | Improve this Doc View Source

    PutInternalPrepared(CacheItem<TCacheValue>)

    Puts the item into the cache. If the item exists it will get updated with the new value. If the item doesn't exist, the item will be added to the cache.

    Declaration
    protected override void PutInternalPrepared(CacheItem<TCacheValue> item)
    Parameters
    Type Name Description
    CacheItem<TCacheValue> item

    The CacheItem to be added to the cache.
    Overrides
    CacheManager.Core.Internal.BaseCacheHandle<TCacheValue>.PutInternalPrepared(CacheManager.Core.CacheItem<TCacheValue>)
    | Improve this Doc View Source

    RemoveInternal(String)

    Removes a value from the cache for the specified key.

    Declaration
    protected override bool RemoveInternal(string key)
    Parameters
    Type Name Description
    String key

    The key being used to identify the item within the cache.
    Returns
    Type Description
    Boolean

    true if the key was found and removed from the cache, false otherwise.
    Overrides
    CacheManager.Core.Internal.BaseCache<TCacheValue>.RemoveInternal(System.String)
    | Improve this Doc View Source

    RemoveInternal(String, String)

    Removes a value from the cache for the specified key.

    Declaration
    protected override bool RemoveInternal(string key, string region)
    Parameters
    Type Name Description
    String key

    The key being used to identify the item within the cache.
    String region

    The cache region.
    Returns
    Type Description
    Boolean

    true if the key was found and removed from the cache, false otherwise.
    Overrides
    CacheManager.Core.Internal.BaseCache<TCacheValue>.RemoveInternal(System.String, System.String)
    | Improve this Doc View Source

    Update(String, Func<TCacheValue, TCacheValue>, Int32)

    Declaration
    public override UpdateItemResult<TCacheValue> Update(string key, Func<TCacheValue, TCacheValue> updateValue, int maxRetries)
    Parameters
    Type Name Description
    String key
    Func<TCacheValue, TCacheValue> updateValue
    Int32 maxRetries
    Returns
    Type Description
    UpdateItemResult<TCacheValue>
    Overrides
    CacheManager.Core.Internal.BaseCacheHandle<TCacheValue>.Update(System.String, System.Func<TCacheValue, TCacheValue>, System.Int32)
    | Improve this Doc View Source

    Update(String, String, Func<TCacheValue, TCacheValue>, Int32)

    Declaration
    public override UpdateItemResult<TCacheValue> Update(string key, string region, Func<TCacheValue, TCacheValue> updateValue, int maxRetries)
    Parameters
    Type Name Description
    String key
    String region
    Func<TCacheValue, TCacheValue> updateValue
    Int32 maxRetries
    Returns
    Type Description
    UpdateItemResult<TCacheValue>
    Overrides
    CacheManager.Core.Internal.BaseCacheHandle<TCacheValue>.Update(System.String, System.String, System.Func<TCacheValue, TCacheValue>, System.Int32)
    | Improve this Doc View Source

    UpdateNoScript(String, String, Func<TCacheValue, TCacheValue>, Int32)

    Declaration
    protected UpdateItemResult<TCacheValue> UpdateNoScript(string key, string region, Func<TCacheValue, TCacheValue> updateValue, int maxRetries)
    Parameters
    Type Name Description
    String key
    String region
    Func<TCacheValue, TCacheValue> updateValue
    Int32 maxRetries
    Returns
    Type Description
    UpdateItemResult<TCacheValue>
    © 2025 by Michael Conrad. All rights reserved. - MichaCo.net