CacheHelper.CacheAsync<TData> Method (Func<CacheSettings, CancellationToken, Task<TData>>, CacheSettings, CancellationToken)

Asynchronously loads data. If multiple threads are loading the same data, only one thread executes the load, stores the result into cache and the result is distributed to other waiting threads. If an exception is thrown during loadMethodAsync execution, the exception is distributed as well. No data are cached in such a case.

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 13.0.131

Syntax

public static Task<TData> CacheAsync<TData>(
	Func<CacheSettings, CancellationToken, Task<TData>> loadMethodAsync,
	CacheSettings settings,
	CancellationToken cancellationToken
)

Parameters

loadMethodAsync

Type: System.Func<CacheSettings, CancellationToken, Task<TData>>
Function accepting cache settings and a cancellation token and returning the asynchronous data loading task.

settings

Type: CMS.Helpers.CacheSettings
Settings configuring the cache.

cancellationToken

Type: System.Threading.CancellationToken
The cancellation instruction.

Type Parameters

TData

Type of data to be loaded.

Return Value

Type: Task<TData>
Returns a task returning the loaded data.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when loadMethodAsync or settings is null.
InvalidOperationException	Thrown when multiple threads are loading the same item (identified by CacheItemName) with incompatible TData.

Remarks

Based on the settings the data is stored into cache. If Cached is set to false, no caching is performed and fresh data are retrieved.

If both progressive load is allowed (both AllowProgressiveCaching and ProgressiveCaching are set to true), the fresh data retrieval is subject to progressive load (i.e. only one threads executes the load and the result is distributed to other waiting threads). Otherwise, the loadMethodAsync is always executed.

No assumptions must be made on which thread executes the loadMethodAsync. The thread creating the underlying load item is not necessarily the one executing the item. Any of the waiting threads can execute the item.

IProgressiveCache can be used to avoid a dependency on this static method.