This repo contains the Microsoft.Extensions.Caching.Distributed.IDistributedCache plugin for the Polly Cache policy. It targets .NET Standard 1.1.
Polly is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, Cache aside and Fallback in a fluent and thread-safe manner. Polly targets .NET 4.0, .NET 4.5 and .NET Standard 1.1.
Polly is a member of the .NET Foundation!
Keep up to date with new feature announcements, tips & tricks, and other news through www.thepollyproject.org
This project, Polly.Caching.IDistributedCache, allows you to use Polly's CachePolicy with implementations of .Net Standard's IDistributedCache.
Install-Package Polly.Caching.IDistributedCache
You can install the Strongly Named version via:
Install-Package Polly.Caching.IDistributedCache-Signed
Polly.Caching.IDistributedCache supports .NetStandard 1.1 and above.
Polly.Caching.IDistributedCache requires:
- Polly v5.4.0 or above.
- Microsoft.Extensions.Caching.Abstractions v1.1.2 or above.
These notes assume you are familiar with using the .Net Standard IDistributedCache implementations. For information, see: https://docs.microsoft.com/en-us/aspnet/core/performance/caching/distributed . As described on that page, Microsoft provide a Redis implementation and an SQL server implementation for IDistributedCache.
Assuming you have an instance IDistributedCache distributedCache in hand (perhaps just configured and instantiated, perhaps provided to local code by Dependency Injection):
// Create a Polly cache policy for caching string results, using that `IDistributedCache` instance.
var cachePolicy = Policy.Cache<string>(distributedCache.AsSyncCacheProvider<string>, TimeSpan.FromMinutes(5));
// Create a Polly cache policy for caching byte[] results, using that `IDistributedCache` instance.
var cachePolicy = Policy.Cache<byte[]>(distributedCache.AsSyncCacheProvider<byte[]>, TimeSpan.FromMinutes(5));
// Or similarly for async executions returning string results:
var cachePolicy = Policy.CacheAsync<string>(distributedCache.AsAsyncCacheProvider<string>, TimeSpan.FromMinutes(5));
// Or similarly for async executions returning byte[] results:
var cachePolicy = Policy.CacheAsync<byte[]>(distributedCache.AsAsyncCacheProvider<byte[]>, TimeSpan.FromMinutes(5));
// You can also use ASP.NET Core's DistributedCacheEntryOptions for specifying cache item time-to-live, as shown below.
// All time-to-live functionality represented by DistributedCacheEntryOptions is supported.
DistributedCacheEntryOptions entryOptions = // ...
var cachePolicy = Policy.CacheAsync<byte[]>(distributedCache.AsAsyncCacheProvider<byte[]>, entryOptions.AsTtlStrategy());
Usage:
string productId = // ... from somewhere
string productDescription = await cachePolicy.ExecuteAsync(() => getProductDescription(productId),
new Context(productId) // productId will also be the cache key used in this execution.
); For many more configuration options and usage examples of the main Polly CachePolicy, see the main Polly readme and deep doco on the Polly wiki. Additional overloads allow attaching delegates for cache errors, cache hits/misses etc, for logging and telemetry.
CachePolicy can of course also be combined with other policies in a PolicyWrap.
For details of changes by release see the change log.
- @seanfarrow and @reisenberger - Initial caching architecture in the main Polly repo
- @reisenberger -
IDistributedCacheimplementation
Please check out our Wiki for contributing guidelines. We are following the excellent GitHub Flow process, and would like to make sure you have all of the information needed to be a world-class contributor!
Since Polly is part of the .NET Foundation, we ask our contributors to abide by their Code of Conduct.
Also, we've stood up a Slack channel for easier real-time discussion of ideas and the general direction of Polly as a whole. Be sure to join the conversation today!
Licensed under the terms of the New BSD License