MagicEastern.CachedFunc2

This library is used to create a cached function. The return value of the function is cached with IMemoryCache.


Keywords
CachedFunc, MemoryCache, IMemoryCache, Cache
License
MIT
Install
Install-Package MagicEastern.CachedFunc2 -Version 1.1.0

Documentation

CachedFunc2

This library is used to create a cached function. The return value of the function is cached with IMemoryCache.

Register The Service

serviceCollection.AddMemoryCache();
serviceCollection.AddCachedFunc();

Then, you can get CachedFuncSvc object through dependency injection.

How to Use

Assume there is a slow-running function.

static int SlowFunc(int n) {
    Thread.Sleep(1000);
    return n;
}

Create CachedFunc with [CachedFuncSvc] object.

CachedFunc<int, int> cachedFunc = cachedFuncSvc.Create(SlowFunc);

Then, you have a cached function. Call this function in the same way as the orignal function.

int result = cachedFunc(12345);

Options

CachedFuncSvc.Create() accepts MemoryCacheEntryOptions argument. In the backend, it creates a MemoryCache entry with all the arguments at the time the CachedFunc<> is called. On the following calls to the CachedFunc<>, the cached value will be returned as long as the cache is not expired based on the MemoryCacheEntryOptions.

For the entry with MemoryCacheEntryOptions.Property.NeverRemove, the Cache will be eager loaded as soon as the current cache entry is expired.