<?xml version="1.0"?>
|
<doc>
|
<assembly>
|
<name>Microsoft.Extensions.Caching.Abstractions</name>
|
</assembly>
|
<members>
|
<member name="T:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions">
|
<summary>
|
Provide extensions methods for <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> operations.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetPriority(Microsoft.Extensions.Caching.Memory.ICacheEntry,Microsoft.Extensions.Caching.Memory.CacheItemPriority)">
|
<summary>
|
Sets the priority for keeping the cache entry in the cache during a memory pressure tokened cleanup.
|
</summary>
|
<param name="entry">The entry to set the priority for.</param>
|
<param name="priority">The <see cref="T:Microsoft.Extensions.Caching.Memory.CacheItemPriority"/> to set on the entry.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.AddExpirationToken(Microsoft.Extensions.Caching.Memory.ICacheEntry,Microsoft.Extensions.Primitives.IChangeToken)">
|
<summary>
|
Expire the cache entry if the given <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> expires.
|
</summary>
|
<param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
|
<param name="expirationToken">The <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that causes the cache entry to expire.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Memory.ICacheEntry,System.TimeSpan)">
|
<summary>
|
Sets an absolute expiration time, relative to now.
|
</summary>
|
<param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
|
<param name="relative">The <see cref="T:System.TimeSpan"/> representing the expiration time relative to now.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Memory.ICacheEntry,System.DateTimeOffset)">
|
<summary>
|
Sets an absolute expiration date for the cache entry.
|
</summary>
|
<param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
|
<param name="absolute">A <see cref="T:System.DateTimeOffset"/> representing the expiration time in absolute terms.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetSlidingExpiration(Microsoft.Extensions.Caching.Memory.ICacheEntry,System.TimeSpan)">
|
<summary>
|
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).
|
</summary>
|
<param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
|
<param name="offset">A <see cref="T:System.TimeSpan"/> representing a sliding expiration.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.RegisterPostEvictionCallback(Microsoft.Extensions.Caching.Memory.ICacheEntry,Microsoft.Extensions.Caching.Memory.PostEvictionDelegate)">
|
<summary>
|
The given callback will be fired after the cache entry is evicted from the cache.
|
</summary>
|
<param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
|
<param name="callback">The callback to run after the entry is evicted.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.RegisterPostEvictionCallback(Microsoft.Extensions.Caching.Memory.ICacheEntry,Microsoft.Extensions.Caching.Memory.PostEvictionDelegate,System.Object)">
|
<summary>
|
The given callback will be fired after the cache entry is evicted from the cache.
|
</summary>
|
<param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
|
<param name="callback">The callback to run after the entry is evicted.</param>
|
<param name="state">The state to pass to the post-eviction callback.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetValue(Microsoft.Extensions.Caching.Memory.ICacheEntry,System.Object)">
|
<summary>
|
Sets the value of the cache entry.
|
</summary>
|
<param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
|
<param name="value">The value to set on the <paramref name="entry"/>.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetSize(Microsoft.Extensions.Caching.Memory.ICacheEntry,System.Int64)">
|
<summary>
|
Sets the size of the cache entry value.
|
</summary>
|
<param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
|
<param name="size">The size to set on the <paramref name="entry"/>.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetOptions(Microsoft.Extensions.Caching.Memory.ICacheEntry,Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions)">
|
<summary>
|
Applies the values of an existing <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> to the entry.
|
</summary>
|
<param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
|
<param name="options">Set the values of these options on the <paramref name="entry"/>.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Memory.CacheItemPriority">
|
<summary>
|
Specifies how items are prioritized for preservation during a memory pressure triggered cleanup.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Caching.Memory.CacheItemPriority.Low">
|
<summary>
|
The cache entry should be removed as soon as possible during memory pressure triggered cleanup.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Caching.Memory.CacheItemPriority.Normal">
|
<summary>
|
The cache entry should be removed if there is no other low priority cache entries during memory pressure triggered cleanup.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Caching.Memory.CacheItemPriority.High">
|
<summary>
|
The cache entry should be removed only when there is no other low or normal priority cache entries during memory pressure triggered cleanup.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Caching.Memory.CacheItemPriority.NeverRemove">
|
<summary>
|
The cache entry should never be removed during memory pressure triggered cleanup.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Memory.EvictionReason">
|
<summary>
|
Specify the reasons why an entry was evicted from the cache.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.None">
|
<summary>
|
The item was not removed from the cache.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.Removed">
|
<summary>
|
The item was removed from the cache manually.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.Replaced">
|
<summary>
|
The item was removed from the cache because it was overwritten.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.Expired">
|
<summary>
|
The item was removed from the cache because it timed out.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.TokenExpired">
|
<summary>
|
The item was removed from the cache because its token expired.
|
</summary>
|
</member>
|
<member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.Capacity">
|
<summary>
|
The item was removed from the cache because it exceeded its capacity.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Memory.ICacheEntry">
|
<summary>
|
Represents an entry in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> implementation.
|
When Disposed, is committed to the cache.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Key">
|
<summary>
|
Gets the key of the cache entry.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Value">
|
<summary>
|
Gets or set the value of the cache entry.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.AbsoluteExpiration">
|
<summary>
|
Gets or sets an absolute expiration date for the cache entry.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.AbsoluteExpirationRelativeToNow">
|
<summary>
|
Gets or sets an absolute expiration time, relative to now.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.SlidingExpiration">
|
<summary>
|
Gets or sets how long a 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).
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.ExpirationTokens">
|
<summary>
|
Gets the <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> instances which cause the cache entry to expire.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.PostEvictionCallbacks">
|
<summary>
|
Gets or sets the callbacks will be fired after the cache entry is evicted from the cache.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Priority">
|
<summary>
|
Gets or sets the priority for keeping the cache entry in the cache during a
|
cleanup. The default is <see cref="F:Microsoft.Extensions.Caching.Memory.CacheItemPriority.Normal"/>.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Size">
|
<summary>
|
Gets or set the size of the cache entry value.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Memory.IMemoryCache">
|
<summary>
|
Represents a local in-memory cache whose values are not serialized.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.IMemoryCache.TryGetValue(System.Object,System.Object@)">
|
<summary>
|
Gets the item associated with this key if present.
|
</summary>
|
<param name="key">An object identifying the requested entry.</param>
|
<param name="value">The located value or null.</param>
|
<returns>True if the key was found.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.IMemoryCache.CreateEntry(System.Object)">
|
<summary>
|
Create or overwrite an entry in the cache.
|
</summary>
|
<param name="key">An object identifying the entry.</param>
|
<returns>The newly created <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> instance.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.IMemoryCache.Remove(System.Object)">
|
<summary>
|
Removes the object associated with the given key.
|
</summary>
|
<param name="key">An object identifying the entry.</param>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.IMemoryCache.GetCurrentStatistics">
|
<summary>
|
Gets a snapshot of the cache statistics if available.
|
</summary>
|
<returns>An instance of <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics"/> containing a snapshot of the cache statistics.</returns>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions">
|
<summary>
|
Provide extensions methods for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> operations.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.SetPriority(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,Microsoft.Extensions.Caching.Memory.CacheItemPriority)">
|
<summary>
|
Sets the priority for keeping the cache entry in the cache during a memory pressure tokened cleanup.
|
</summary>
|
<param name="options">The option on which to set the priority.</param>
|
<param name="priority">The <see cref="T:Microsoft.Extensions.Caching.Memory.CacheItemPriority"/> to set on the option.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.SetSize(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,System.Int64)">
|
<summary>
|
Sets the size of the cache entry value.
|
</summary>
|
<param name="options">The options to set the entry size on.</param>
|
<param name="size">The size to set on the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.AddExpirationToken(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,Microsoft.Extensions.Primitives.IChangeToken)">
|
<summary>
|
Expire the cache entry if the given <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> expires.
|
</summary>
|
<param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
|
<param name="expirationToken">The <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that causes the cache entry to expire.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,System.TimeSpan)">
|
<summary>
|
Sets an absolute expiration time, relative to now.
|
</summary>
|
<param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
|
<param name="relative">The expiration time, relative to now.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,System.DateTimeOffset)">
|
<summary>
|
Sets an absolute expiration date for the cache entry.
|
</summary>
|
<param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
|
<param name="absolute">The expiration time, in absolute terms.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.SetSlidingExpiration(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,System.TimeSpan)">
|
<summary>
|
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).
|
</summary>
|
<param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
|
<param name="offset">The sliding expiration time.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.RegisterPostEvictionCallback(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,Microsoft.Extensions.Caching.Memory.PostEvictionDelegate)">
|
<summary>
|
The given callback will be fired after the cache entry is evicted from the cache.
|
</summary>
|
<param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
|
<param name="callback">The callback to register for calling after an entry is evicted.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.RegisterPostEvictionCallback(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,Microsoft.Extensions.Caching.Memory.PostEvictionDelegate,System.Object)">
|
<summary>
|
The given callback will be fired after the cache entry is evicted from the cache.
|
</summary>
|
<param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
|
<param name="callback">The callback to register for calling after an entry is evicted.</param>
|
<param name="state">The state to pass to the callback.</param>
|
<returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions">
|
<summary>
|
Represents the cache options applied to an entry of the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.AbsoluteExpiration">
|
<summary>
|
Gets or sets an absolute expiration date for the cache entry.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.AbsoluteExpirationRelativeToNow">
|
<summary>
|
Gets or sets an absolute expiration time, relative to now.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.SlidingExpiration">
|
<summary>
|
Gets or sets how long a 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).
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.ExpirationTokens">
|
<summary>
|
Gets the <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> instances which cause the cache entry to expire.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.PostEvictionCallbacks">
|
<summary>
|
Gets or sets the callbacks will be fired after the cache entry is evicted from the cache.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.Priority">
|
<summary>
|
Gets or sets the priority for keeping the cache entry in the cache during a
|
memory pressure triggered cleanup. The default is <see cref="F:Microsoft.Extensions.Caching.Memory.CacheItemPriority.Normal"/>.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.Size">
|
<summary>
|
Gets or sets the size of the cache entry value.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Memory.CacheExtensions">
|
<summary>
|
Provide extensions methods for <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> operations.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheExtensions.Get(Microsoft.Extensions.Caching.Memory.IMemoryCache,System.Object)">
|
<summary>
|
Gets the value associated with this key if present.
|
</summary>
|
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance this method extends.</param>
|
<param name="key">The key of the value to get.</param>
|
<returns>The value associated with this key, or <c>null</c> if the key is not present.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheExtensions.Get``1(Microsoft.Extensions.Caching.Memory.IMemoryCache,System.Object)">
|
<summary>
|
Gets the value associated with this key if present.
|
</summary>
|
<typeparam name="TItem">The type of the object to get.</typeparam>
|
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance this method extends.</param>
|
<param name="key">The key of the value to get.</param>
|
<returns>The value associated with this key, or <c>default(TItem)</c> if the key is not present.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheExtensions.TryGetValue``1(Microsoft.Extensions.Caching.Memory.IMemoryCache,System.Object,``0@)">
|
<summary>
|
Try to get the value associated with the given key.
|
</summary>
|
<typeparam name="TItem">The type of the object to get.</typeparam>
|
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance this method extends.</param>
|
<param name="key">The key of the value to get.</param>
|
<param name="value">The value associated with the given key.</param>
|
<returns><c>true</c> if the key was found. <c>false</c> otherwise.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheExtensions.Set``1(Microsoft.Extensions.Caching.Memory.IMemoryCache,System.Object,``0)">
|
<summary>
|
Associate a value with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
</summary>
|
<typeparam name="TItem">The type of the object to set.</typeparam>
|
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance this method extends.</param>
|
<param name="key">The key of the entry to add.</param>
|
<param name="value">The value to associate with the key.</param>
|
<returns>The value that was set.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheExtensions.Set``1(Microsoft.Extensions.Caching.Memory.IMemoryCache,System.Object,``0,System.DateTimeOffset)">
|
<summary>
|
Sets a cache entry with the given key and value that will expire in the given duration.
|
</summary>
|
<typeparam name="TItem">The type of the object to set.</typeparam>
|
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance this method extends.</param>
|
<param name="key">The key of the entry to add.</param>
|
<param name="value">The value to associate with the key.</param>
|
<param name="absoluteExpiration">The point in time at which the cache entry will expire.</param>
|
<returns>The value that was set.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheExtensions.Set``1(Microsoft.Extensions.Caching.Memory.IMemoryCache,System.Object,``0,System.TimeSpan)">
|
<summary>
|
Sets a cache entry with the given key and value that will expire in the given duration from now.
|
</summary>
|
<typeparam name="TItem">The type of the object to set.</typeparam>
|
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance this method extends.</param>
|
<param name="key">The key of the entry to add.</param>
|
<param name="value">The value to associate with the key.</param>
|
<param name="absoluteExpirationRelativeToNow">The duration from now after which the cache entry will expire.</param>
|
<returns>The value that was set.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheExtensions.Set``1(Microsoft.Extensions.Caching.Memory.IMemoryCache,System.Object,``0,Microsoft.Extensions.Primitives.IChangeToken)">
|
<summary>
|
Sets a cache entry with the given key and value that will expire when <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> expires.
|
</summary>
|
<typeparam name="TItem">The type of the object to set.</typeparam>
|
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance this method extends.</param>
|
<param name="key">The key of the entry to add.</param>
|
<param name="value">The value to associate with the key.</param>
|
<param name="expirationToken">The <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that causes the cache entry to expire.</param>
|
<returns>The value that was set.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheExtensions.Set``1(Microsoft.Extensions.Caching.Memory.IMemoryCache,System.Object,``0,Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions)">
|
<summary>
|
Sets a cache entry with the given key and value and apply the values of an existing <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> to the created entry.
|
</summary>
|
<typeparam name="TItem">The type of the object to set.</typeparam>
|
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance this method extends.</param>
|
<param name="key">The key of the entry to add.</param>
|
<param name="value">The value to associate with the key.</param>
|
<param name="options">The existing <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> instance to apply to the new entry.</param>
|
<returns>The value that was set.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheExtensions.GetOrCreate``1(Microsoft.Extensions.Caching.Memory.IMemoryCache,System.Object,System.Func{Microsoft.Extensions.Caching.Memory.ICacheEntry,``0})">
|
<summary>
|
Gets the value associated with this key if it exists, or generates a new entry using the provided key and a value from the given factory if the key is not found.
|
</summary>
|
<typeparam name="TItem">The type of the object to get.</typeparam>
|
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance this method extends.</param>
|
<param name="key">The key of the entry to look for or create.</param>
|
<param name="factory">The factory that creates the value associated with this key if the key does not exist in the cache.</param>
|
<returns>The value associated with this key.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.CacheExtensions.GetOrCreateAsync``1(Microsoft.Extensions.Caching.Memory.IMemoryCache,System.Object,System.Func{Microsoft.Extensions.Caching.Memory.ICacheEntry,System.Threading.Tasks.Task{``0}})">
|
<summary>
|
Asynchronously gets the value associated with this key if it exists, or generates a new entry using the provided key and a value from the given factory if the key is not found.
|
</summary>
|
<typeparam name="TItem">The type of the object to get.</typeparam>
|
<param name="cache">The <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance this method extends.</param>
|
<param name="key">The key of the entry to look for or create.</param>
|
<param name="factory">The factory task that creates the value associated with this key if the key does not exist in the cache.</param>
|
<returns>The task object representing the asynchronous operation.</returns>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics">
|
<summary>
|
Holds a snapshot of statistics for a memory cache.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.#ctor">
|
<summary>
|
Initializes an instance of MemoryCacheStatistics.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.CurrentEntryCount">
|
<summary>
|
Gets the number of <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry" /> instances currently in the memory cache.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.CurrentEstimatedSize">
|
<summary>
|
Gets an estimated sum of all the <see cref="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Size" /> values currently in the memory cache.
|
</summary>
|
<returns>Returns <see langword="null"/> if size isn't being tracked. The common MemoryCache implementation tracks size whenever a SizeLimit is set on the cache.</returns>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.TotalMisses">
|
<summary>
|
Gets the total number of cache misses.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.TotalHits">
|
<summary>
|
Gets the total number of cache hits.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Memory.PostEvictionCallbackRegistration">
|
<summary>
|
Represents a callback delegate that will be fired after an entry is evicted from the cache.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.PostEvictionCallbackRegistration.EvictionCallback">
|
<summary>
|
Gets or sets the callback delegate that will be fired after an entry is evicted from the cache.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Memory.PostEvictionCallbackRegistration.State">
|
<summary>
|
Gets or sets the state to pass to the callback delegate.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Memory.PostEvictionDelegate">
|
<summary>
|
Signature of the callback which gets called when a cache entry expires.
|
</summary>
|
<param name="key">The key of the entry being evicted.</param>
|
<param name="value">The value of the entry being evicted.</param>
|
<param name="reason">The <see cref="T:Microsoft.Extensions.Caching.Memory.EvictionReason"/>.</param>
|
<param name="state">The information that was passed when registering the callback.</param>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryExtensions">
|
<summary>
|
Extension methods for <see cref="T:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions"/> operations.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.TimeSpan)">
|
<summary>
|
Sets an absolute expiration time, relative to now.
|
</summary>
|
<param name="options">The options to be operated on.</param>
|
<param name="relative">The expiration time, relative to now.</param>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.DateTimeOffset)">
|
<summary>
|
Sets an absolute expiration date for the cache entry.
|
</summary>
|
<param name="options">The options to be operated on.</param>
|
<param name="absolute">The expiration time, in absolute terms.</param>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryExtensions.SetSlidingExpiration(Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.TimeSpan)">
|
<summary>
|
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).
|
</summary>
|
<param name="options">The options to be operated on.</param>
|
<param name="offset">The sliding expiration time.</param>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions">
|
<summary>
|
Provides the cache options for an entry in <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/>.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions.AbsoluteExpiration">
|
<summary>
|
Gets or sets an absolute expiration date for the cache entry.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions.AbsoluteExpirationRelativeToNow">
|
<summary>
|
Gets or sets an absolute expiration time, relative to now.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions.SlidingExpiration">
|
<summary>
|
Gets or sets how long a 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).
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions">
|
<summary>
|
Extension methods for setting data in an <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache" />.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.Set(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.Byte[])">
|
<summary>
|
Sets a sequence of bytes in the specified cache with the specified key.
|
</summary>
|
<param name="cache">The cache in which to store the data.</param>
|
<param name="key">The key to store the data in.</param>
|
<param name="value">The data to store in the cache.</param>
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetAsync(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.Byte[],System.Threading.CancellationToken)">
|
<summary>
|
Asynchronously sets a sequence of bytes in the specified cache with the specified key.
|
</summary>
|
<param name="cache">The cache in which to store the data.</param>
|
<param name="key">The key to store the data in.</param>
|
<param name="value">The data to store in the cache.</param>
|
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
|
<returns>A task that represents the asynchronous set operation.</returns>
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String)">
|
<summary>
|
Sets a string in the specified cache with the specified key.
|
</summary>
|
<param name="cache">The cache in which to store the data.</param>
|
<param name="key">The key to store the data in.</param>
|
<param name="value">The data to store in the cache.</param>
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String,Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)">
|
<summary>
|
Sets a string in the specified cache with the specified key.
|
</summary>
|
<param name="cache">The cache in which to store the data.</param>
|
<param name="key">The key to store the data in.</param>
|
<param name="value">The data to store in the cache.</param>
|
<param name="options">The cache options for the entry.</param>
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetStringAsync(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String,System.Threading.CancellationToken)">
|
<summary>
|
Asynchronously sets a string in the specified cache with the specified key.
|
</summary>
|
<param name="cache">The cache in which to store the data.</param>
|
<param name="key">The key to store the data in.</param>
|
<param name="value">The data to store in the cache.</param>
|
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
|
<returns>A task that represents the asynchronous set operation.</returns>
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetStringAsync(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String,Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)">
|
<summary>
|
Asynchronously sets a string in the specified cache with the specified key.
|
</summary>
|
<param name="cache">The cache in which to store the data.</param>
|
<param name="key">The key to store the data in.</param>
|
<param name="value">The data to store in the cache.</param>
|
<param name="options">The cache options for the entry.</param>
|
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
|
<returns>A task that represents the asynchronous set operation.</returns>
|
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.GetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String)">
|
<summary>
|
Gets a string from the specified cache with the specified key.
|
</summary>
|
<param name="cache">The cache in which to store the data.</param>
|
<param name="key">The key to get the stored data for.</param>
|
<returns>The string value from the stored cache key.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.GetStringAsync(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.Threading.CancellationToken)">
|
<summary>
|
Asynchronously gets a string from the specified cache with the specified key.
|
</summary>
|
<param name="cache">The cache in which to store the data.</param>
|
<param name="key">The key to get the stored data for.</param>
|
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
|
<returns>A task that gets the string value from the stored cache key.</returns>
|
</member>
|
<member name="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache">
|
<summary>
|
Represents a distributed cache of serialized values.
|
</summary>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Get(System.String)">
|
<summary>
|
Gets a value with the given key.
|
</summary>
|
<param name="key">A string identifying the requested value.</param>
|
<returns>The located value or null.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.GetAsync(System.String,System.Threading.CancellationToken)">
|
<summary>
|
Gets a value with the given key.
|
</summary>
|
<param name="key">A string identifying the requested value.</param>
|
<param name="token">Optional. The <see cref="T:System.Threading.CancellationToken"/> used to propagate notifications that the operation should be canceled.</param>
|
<returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation, containing the located value or null.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)">
|
<summary>
|
Sets a value with the given key.
|
</summary>
|
<param name="key">A string identifying the requested value.</param>
|
<param name="value">The value to set in the cache.</param>
|
<param name="options">The cache options for the value.</param>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.SetAsync(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)">
|
<summary>
|
Sets the value with the given key.
|
</summary>
|
<param name="key">A string identifying the requested value.</param>
|
<param name="value">The value to set in the cache.</param>
|
<param name="options">The cache options for the value.</param>
|
<param name="token">Optional. The <see cref="T:System.Threading.CancellationToken"/> used to propagate notifications that the operation should be canceled.</param>
|
<returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Refresh(System.String)">
|
<summary>
|
Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any).
|
</summary>
|
<param name="key">A string identifying the requested value.</param>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.RefreshAsync(System.String,System.Threading.CancellationToken)">
|
<summary>
|
Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any).
|
</summary>
|
<param name="key">A string identifying the requested value.</param>
|
<param name="token">Optional. The <see cref="T:System.Threading.CancellationToken"/> used to propagate notifications that the operation should be canceled.</param>
|
<returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Remove(System.String)">
|
<summary>
|
Removes the value with the given key.
|
</summary>
|
<param name="key">A string identifying the requested value.</param>
|
</member>
|
<member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.RemoveAsync(System.String,System.Threading.CancellationToken)">
|
<summary>
|
Removes the value with the given key.
|
</summary>
|
<param name="key">A string identifying the requested value.</param>
|
<param name="token">Optional. The <see cref="T:System.Threading.CancellationToken"/> used to propagate notifications that the operation should be canceled.</param>
|
<returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
|
</member>
|
<member name="T:Microsoft.Extensions.Internal.ISystemClock">
|
<summary>
|
Abstracts the system clock to facilitate testing.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Internal.ISystemClock.UtcNow">
|
<summary>
|
Retrieves the current system time in UTC.
|
</summary>
|
</member>
|
<member name="T:Microsoft.Extensions.Internal.SystemClock">
|
<summary>
|
Provides access to the normal system clock.
|
</summary>
|
</member>
|
<member name="P:Microsoft.Extensions.Internal.SystemClock.UtcNow">
|
<summary>
|
Retrieves the current system time in UTC.
|
</summary>
|
</member>
|
<member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
|
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
<param name="argument">The reference type argument to validate as non-null.</param>
|
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
</member>
|
<member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
|
<summary>
|
Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
|
if the specified string is <see langword="null"/> or whitespace respectively.
|
</summary>
|
<param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
|
<param name="paramName">The name of the parameter being checked.</param>
|
<returns>The original value of <paramref name="argument"/>.</returns>
|
</member>
|
</members>
|
</doc>
|
