IDistributedCache code documentation.

framework/src/Volo.Abp.Caching/Volo/Abp/Caching/CacheOptions.cs

@@ -10,11 +10,13 @@ namespace Volo.Abp.Caching
         /// Global Cache entry options.
         /// </summary>
         public DistributedCacheEntryOptions GlobalCacheEntryOptions { get; set; }
+
         /// <summary>
         /// List of all cache configurators.
         /// (func argument:Name of cache)
         /// </summary>
         public List<Func<string, DistributedCacheEntryOptions>> CacheConfigurators { get; set; } //TODO  list item use a configurator interface instead?
+
         public CacheOptions()
         {
             CacheConfigurators = new List<Func<string, DistributedCacheEntryOptions>>();

framework/src/Volo.Abp.Caching/Volo/Abp/Caching/DistributedCache.cs

@@ -12,6 +12,10 @@ using Volo.Abp.Threading;
 
 namespace Volo.Abp.Caching
 {
+    /// <summary>
+    /// Represents a distributed cache of <typeparamref name="TCacheItem" /> type.
+    /// </summary>
+    /// <typeparam name="TCacheItem">The type of cache item being cached.</typeparam>
     public class DistributedCache<TCacheItem> : IDistributedCache<TCacheItem>
         where TCacheItem : class
     {
@@ -57,6 +61,12 @@ namespace Volo.Abp.Caching
             SetDefaultOptions();
         }
 
+        /// <summary>
+        /// Gets a cache item with the given key. If no cache item is found for the given key then returns null.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <returns>The cache item, or null.</returns>
         public virtual TCacheItem Get(
             string key, 
             bool? hideErrors = null)
@@ -88,6 +98,13 @@ namespace Volo.Abp.Caching
             return Serializer.Deserialize<TCacheItem>(cachedBytes);
         }
 
+        /// <summary>
+        /// Gets a cache item with the given key. If no cache item is found for the given key then returns null.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
+        /// <returns>The cache item, or null.</returns>
         public virtual async Task<TCacheItem> GetAsync(
             string key,
             bool? hideErrors = null, 
@@ -123,6 +140,15 @@ namespace Volo.Abp.Caching
             return Serializer.Deserialize<TCacheItem>(cachedBytes);
         }
 
+        /// <summary>
+        /// Gets or Adds a cache item with the given key. If no cache item is found for the given key then adds a cache item
+        /// provided by <paramref name="factory" /> delegate and returns the provided cache item.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="factory">The factory delegate is used to provide the cache item when no cache item is found for the given <paramref name="key" />.</param>
+        /// <param name="optionsFactory">The cache options for the factory delegate.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <returns>The cache item.</returns>
         public TCacheItem GetOrAdd(
             string key,
             Func<TCacheItem> factory,
@@ -150,6 +176,16 @@ namespace Volo.Abp.Caching
             return value;
         }
 
+        /// <summary>
+        /// Gets or Adds a cache item with the given key. If no cache item is found for the given key then adds a cache item
+        /// provided by <paramref name="factory" /> delegate and returns the provided cache item.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="factory">The factory delegate is used to provide the cache item when no cache item is found for the given <paramref name="key" />.</param>
+        /// <param name="optionsFactory">The cache options for the factory delegate.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
+        /// <returns>The cache item.</returns>
         public async Task<TCacheItem> GetOrAddAsync(
             string key,
             Func<Task<TCacheItem>> factory,
@@ -179,6 +215,13 @@ namespace Volo.Abp.Caching
             return value;
         }
 
+        /// <summary>
+        /// Sets the cache item value for the provided key.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="value">The cache item value to set in the cache.</param>
+        /// <param name="options">The cache options for the value.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
         public virtual void Set(
             string key, 
             TCacheItem value, 
@@ -207,6 +250,15 @@ namespace Volo.Abp.Caching
             }
         }
 
+        /// <summary>
+        /// Sets the cache item value for the provided key.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="value">The cache item value to set in the cache.</param>
+        /// <param name="options">The cache options for the value.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
+        /// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
         public virtual async Task SetAsync(
             string key, 
             TCacheItem value, 
@@ -237,6 +289,11 @@ namespace Volo.Abp.Caching
             }
         }
 
+        /// <summary>
+        /// Refreshes the cache value of the given key, and resets its sliding expiration timeout.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
         public virtual void Refresh(
             string key, 
             bool? hideErrors = null)
@@ -259,6 +316,13 @@ namespace Volo.Abp.Caching
             }
         }
 
+        /// <summary>
+        /// Refreshes the cache value of the given key, and resets its sliding expiration timeout.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
+        /// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
         public virtual async Task RefreshAsync(
             string key, 
             bool? hideErrors = null, 
@@ -282,6 +346,12 @@ namespace Volo.Abp.Caching
             }
         }
 
+
+        /// <summary>
+        /// Removes the cache item for given key from cache.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
         public virtual void Remove(
             string key, 
             bool? hideErrors = null)
@@ -303,6 +373,13 @@ namespace Volo.Abp.Caching
             }
         }
 
+        /// <summary>
+        /// Removes the cache item for given key from cache.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
+        /// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
         public virtual async Task RemoveAsync(
             string key, 
             bool? hideErrors = null, 

framework/src/Volo.Abp.Caching/Volo/Abp/Caching/IDistributedCache.cs

@@ -6,20 +6,46 @@ using Microsoft.Extensions.Caching.Distributed;
 
 namespace Volo.Abp.Caching
 {
+    /// <summary>
+    /// Represents a distributed cache of <typeparamref name="TCacheItem" /> type.
+    /// </summary>
+    /// <typeparam name="TCacheItem">The type of cache item being cached.</typeparam>
     public interface IDistributedCache<TCacheItem>
         where TCacheItem : class
     {
+        /// <summary>
+        /// Gets a cache item with the given key. If no cache item is found for the given key then returns null.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <returns>The cache item, or null.</returns>
         TCacheItem Get(
             string key,
             bool? hideErrors = null
         );
 
+        /// <summary>
+        /// Gets a cache item with the given key. If no cache item is found for the given key then returns null.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
+        /// <returns>The cache item, or null.</returns>
         Task<TCacheItem> GetAsync(
             [NotNull] string key,
             bool? hideErrors = null,
             CancellationToken token = default
         );
 
+        /// <summary>
+        /// Gets or Adds a cache item with the given key. If no cache item is found for the given key then adds a cache item
+        /// provided by <paramref name="factory" /> delegate and returns the provided cache item.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="factory">The factory delegate is used to provide the cache item when no cache item is found for the given <paramref name="key" />.</param>
+        /// <param name="optionsFactory">The cache options for the factory delegate.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <returns>The cache item.</returns>
         TCacheItem GetOrAdd(
             string key,
             Func<TCacheItem> factory,
@@ -27,6 +53,16 @@ namespace Volo.Abp.Caching
             bool? hideErrors = null
         );
 
+        /// <summary>
+        /// Gets or Adds a cache item with the given key. If no cache item is found for the given key then adds a cache item
+        /// provided by <paramref name="factory" /> delegate and returns the provided cache item.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="factory">The factory delegate is used to provide the cache item when no cache item is found for the given <paramref name="key" />.</param>
+        /// <param name="optionsFactory">The cache options for the factory delegate.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
+        /// <returns>The cache item.</returns>
         Task<TCacheItem> GetOrAddAsync(
             [NotNull] string key,
             Func<Task<TCacheItem>> factory,
@@ -35,6 +71,13 @@ namespace Volo.Abp.Caching
             CancellationToken token = default
         );
 
+        /// <summary>
+        /// Sets the cache item value for the provided key.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="value">The cache item value to set in the cache.</param>
+        /// <param name="options">The cache options for the value.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
         void Set(
             string key,
             TCacheItem value,
@@ -42,6 +85,15 @@ namespace Volo.Abp.Caching
             bool? hideErrors = null
         );
 
+        /// <summary>
+        /// Sets the cache item value for the provided key.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="value">The cache item value to set in the cache.</param>
+        /// <param name="options">The cache options for the value.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
+        /// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
         Task SetAsync(
             [NotNull] string key,
             [NotNull] TCacheItem value,
@@ -50,22 +102,46 @@ namespace Volo.Abp.Caching
             CancellationToken token = default
         );
 
+        /// <summary>
+        /// Refreshes the cache value of the given key, and resets its sliding expiration timeout.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
         void Refresh(
             string key,
             bool? hideErrors = null
         );
 
+        /// <summary>
+        /// Refreshes the cache value of the given key, and resets its sliding expiration timeout.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
+        /// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
         Task RefreshAsync(
             string key,
             bool? hideErrors = null,
             CancellationToken token = default
         );
 
+        /// <summary>
+        /// Removes the cache item for given key from cache.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
         void Remove(
             string key,
             bool? hideErrors = null
         );
 
+        /// <summary>
+        /// Removes the cache item for given key from cache.
+        /// </summary>
+        /// <param name="key">The key of cached item to be retrieved from the cache.</param>
+        /// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
+        /// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
+        /// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
         Task RemoveAsync(
             string key,
             bool? hideErrors = null,