CacheEntryExtensions Class¶
- Namespace
Microsoft.Extensions.Caching.Memory
- Assemblies
- Microsoft.Extensions.Caching.Abstractions
Syntax¶
public class CacheEntryExtensions
-
class
Microsoft.Extensions.Caching.Memory.
CacheEntryExtensions
Methods¶
-
AddExpirationToken
(Microsoft.Extensions.Caching.Memory.ICacheEntry, Microsoft.Extensions.Primitives.IChangeToken)¶ Expire the cache entry if the given
Microsoft.Extensions.Primitives.IChangeToken
expires.Arguments: - entry (Microsoft.Extensions.Caching.Memory.ICacheEntry) – The
Microsoft.Extensions.Caching.Memory.ICacheEntry
. - expirationToken (Microsoft.Extensions.Primitives.IChangeToken) – The
Microsoft.Extensions.Primitives.IChangeToken
that causes the cache entry to expire.
Return type: public static ICacheEntry AddExpirationToken(this ICacheEntry entry, IChangeToken expirationToken)
- entry (Microsoft.Extensions.Caching.Memory.ICacheEntry) – The
-
RegisterPostEvictionCallback
(Microsoft.Extensions.Caching.Memory.ICacheEntry, Microsoft.Extensions.Caching.Memory.PostEvictionDelegate)¶ The given callback will be fired after the cache entry is evicted from the cache.
Return type: Microsoft.Extensions.Caching.Memory.ICacheEntry public static ICacheEntry RegisterPostEvictionCallback(this ICacheEntry entry, PostEvictionDelegate callback)
-
RegisterPostEvictionCallback
(Microsoft.Extensions.Caching.Memory.ICacheEntry, Microsoft.Extensions.Caching.Memory.PostEvictionDelegate, System.Object) The given callback will be fired after the cache entry is evicted from the cache.
Return type: Microsoft.Extensions.Caching.Memory.ICacheEntry public static ICacheEntry RegisterPostEvictionCallback(this ICacheEntry entry, PostEvictionDelegate callback, object state)
-
SetAbsoluteExpiration
(Microsoft.Extensions.Caching.Memory.ICacheEntry, System.DateTimeOffset)¶ Sets an absolute expiration date for the cache entry.
Return type: Microsoft.Extensions.Caching.Memory.ICacheEntry public static ICacheEntry SetAbsoluteExpiration(this ICacheEntry entry, DateTimeOffset absolute)
-
SetAbsoluteExpiration
(Microsoft.Extensions.Caching.Memory.ICacheEntry, System.TimeSpan) Sets an absolute expiration time, relative to now.
Return type: Microsoft.Extensions.Caching.Memory.ICacheEntry public static ICacheEntry SetAbsoluteExpiration(this ICacheEntry entry, TimeSpan relative)
-
SetOptions
(Microsoft.Extensions.Caching.Memory.ICacheEntry, Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions)¶ Applies the values of an existing
Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions
to the entry.Return type: Microsoft.Extensions.Caching.Memory.ICacheEntry public static ICacheEntry SetOptions(this ICacheEntry entry, MemoryCacheEntryOptions options)
-
SetPriority
(Microsoft.Extensions.Caching.Memory.ICacheEntry, Microsoft.Extensions.Caching.Memory.CacheItemPriority)¶ Sets the priority for keeping the cache entry in the cache during a memory pressure tokened cleanup.
Return type: Microsoft.Extensions.Caching.Memory.ICacheEntry public static ICacheEntry SetPriority(this ICacheEntry entry, CacheItemPriority priority)
-
SetSlidingExpiration
(Microsoft.Extensions.Caching.Memory.ICacheEntry, System.TimeSpan)¶ Sets how long the cache entry can be inactive (e.g. not accessed) before it will be removed. This will not extend the entry lifetime beyond the absolute expiration (if set).
Return type: Microsoft.Extensions.Caching.Memory.ICacheEntry public static ICacheEntry SetSlidingExpiration(this ICacheEntry entry, TimeSpan offset)
-
SetValue
(Microsoft.Extensions.Caching.Memory.ICacheEntry, System.Object)¶ Sets the value of the cache entry.
Return type: Microsoft.Extensions.Caching.Memory.ICacheEntry public static ICacheEntry SetValue(this ICacheEntry entry, object value)
-