typo: Rename ExpirationMode.ImmediateExpiry => ExpirationMode.ImmediateEviction

Author: alastairtree

LazyCache.UnitTests/CachingServiceMemoryCacheProviderTests.cs

@@ -870,7 +870,7 @@ ComplexTestObject GetStuff()
             MemoryCacheEntryOptions GetOptions()
             {
                 var options = new LazyCacheEntryOptions()
-                    .SetAbsoluteExpiration(refreshInterval, ExpirationMode.ImmediateExpiration);
+                    .SetAbsoluteExpiration(refreshInterval, ExpirationMode.ImmediateEviction);
                 options.RegisterPostEvictionCallback((keyEvicted, value, reason, state) =>
                 {
                     if (reason == EvictionReason.Expired  || reason == EvictionReason.TokenExpired)
@@ -900,7 +900,7 @@ public async Task GetOrAddAsyncWithImmediateExpirationDoesExpireItems()
                 () =>
                 {
                     return Task.FromResult(new ComplexTestObject());
-                }, DateTimeOffset.UtcNow.AddMilliseconds(millisecondsCacheDuration), ExpirationMode.ImmediateExpiration);
+                }, DateTimeOffset.UtcNow.AddMilliseconds(millisecondsCacheDuration), ExpirationMode.ImmediateEviction);
             // trigger expiry
             Thread.Sleep(TimeSpan.FromMilliseconds(millisecondsCacheDuration + 50));
 

LazyCache/AppCacheExtensions.cs

@@ -51,10 +51,8 @@ public static T GetOrAdd<T>(this IAppCache cache, string key, Func<T> addItemFac
             {
                 case ExpirationMode.LazyExpiration:
                     return cache.GetOrAdd(key, addItemFactory, new MemoryCacheEntryOptions { AbsoluteExpiration = expires });
-                case ExpirationMode.ImmediateExpiration:
-                    return cache.GetOrAdd(key, addItemFactory, LazyCacheEntryOptions.WithImmediateAbsoluteExpiration(expires));
                 default:
-                    throw new ArgumentOutOfRangeException(nameof(mode), mode, null);
+                    return cache.GetOrAdd(key, addItemFactory, new LazyCacheEntryOptions().SetAbsoluteExpiration(expires, mode));
             }
         }
 
@@ -97,10 +95,8 @@ public static Task<T> GetOrAddAsync<T>(this IAppCache cache, string key, Func<Ta
             {
                 case ExpirationMode.LazyExpiration:
                     return cache.GetOrAddAsync(key, addItemFactory, new MemoryCacheEntryOptions { AbsoluteExpiration = expires });
-                case ExpirationMode.ImmediateExpiration:
-                    return cache.GetOrAddAsync(key, addItemFactory, new LazyCacheEntryOptions().SetAbsoluteExpiration(expires,mode));
                 default:
-                    throw new ArgumentOutOfRangeException(nameof(mode), mode, null);
+                    return cache.GetOrAddAsync(key, addItemFactory, new LazyCacheEntryOptions().SetAbsoluteExpiration(expires, mode));
             }
         }
 

LazyCache/ExpirationMode.cs

@@ -1,4 +1,7 @@
-namespace LazyCache
+using System;
+using System.Diagnostics;
+
+namespace LazyCache
 {
     public enum ExpirationMode
     {
@@ -15,6 +18,14 @@ public enum ExpirationMode
         ///     This will then trigger PostEvictionCallbacks at the expected time. This uses more resources
         ///     than LazyExpiration.
         /// </summary>
-        ImmediateExpiration
+        [Obsolete("Use ExpirationMode.ImmediateEviction instead - this name is miss-leading")]
+        ImmediateExpiration,
+
+        /// <summary>
+        ///     Use a timer to force eviction of expired items from the cache as soon as they expire.
+        ///     This will then trigger PostEvictionCallbacks at the expected time. This uses more resources
+        ///     than LazyExpiration.
+        /// </summary>
+        ImmediateEviction
     }
 }

LazyCache/Providers/MemoryCacheProvider.cs

@@ -35,14 +35,14 @@ public object GetOrCreate<T>(string key, MemoryCacheEntryOptions policy, Func<IC
             if(policy == null)
                 return cache.GetOrCreate(key, factory);
 
-            if (!cache.TryGetValue(key, out object result))
+            if (!cache.TryGetValue(key, out var result))
             {
                 var entry = cache.CreateEntry(key);
                 // Set the initial options before the factory is fired so that any callbacks
                 // that need to be wired up are still added.
                 entry.SetOptions(policy);
 
-                if (policy is LazyCacheEntryOptions lazyPolicy && lazyPolicy.ExpirationMode == ExpirationMode.ImmediateExpiration)
+                if (policy is LazyCacheEntryOptions lazyPolicy && lazyPolicy.ExpirationMode != ExpirationMode.LazyExpiration)
                 {
                     var expiryTokenSource = new CancellationTokenSource();
                     var expireToken = new CancellationChangeToken(expiryTokenSource.Token);

ReleaseNotes.md

@@ -1,5 +1,8 @@
 # Release notes for LazyCache #
 
+## Version 2.1.3
+- Rename ExpirationMode.ImmediateExpiry => ExpirationMode.ImmediateEviction
+
 ## Version 2.1.2
 - Tweak key lock array size based on CPU count so larger for bigger machines (See PR #126 and discussion with @jjxtra)