add nugets
This commit is contained in:
master
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "JFaK0cYAvLmdlIGSZ+2B8kEBK/4003V2qwmwykCnoJL2N0sOuGDui69nZeGd2l42NpSko4uV9tZkMKvCrAk2qw==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
.nuget/packages/microsoft.extensions.caching.memory/10.0.0-preview.7.25380.108/.signature.p7s
vendored
Normal file
BIN
.nuget/packages/microsoft.extensions.caching.memory/10.0.0-preview.7.25380.108/.signature.p7s
vendored
Normal file
Binary file not shown.
BIN
.nuget/packages/microsoft.extensions.caching.memory/10.0.0-preview.7.25380.108/Icon.png
vendored
Normal file
BIN
.nuget/packages/microsoft.extensions.caching.memory/10.0.0-preview.7.25380.108/Icon.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,56 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Caching.Memory</id>
|
||||
<version>10.0.0-preview.7.25380.108</version>
|
||||
<authors>Microsoft</authors>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://dot.net/</projectUrl>
|
||||
<description>In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.</description>
|
||||
<releaseNotes>https://go.microsoft.com/fwlink/?LinkID=799421</releaseNotes>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="30000d883e06c122311a66894579bc12329a09d4" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="Microsoft.Extensions.Caching.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Options" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="System.ValueTuple" version="4.6.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net8.0">
|
||||
<dependency id="Microsoft.Extensions.Caching.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Options" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net9.0">
|
||||
<dependency id="Microsoft.Extensions.Caching.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Options" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.Extensions.Caching.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Options" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.Caching.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.DependencyInjection.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Logging.Abstractions" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Options" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Primitives" version="10.0.0-preview.7.25380.108" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
89
.nuget/packages/microsoft.extensions.caching.memory/10.0.0-preview.7.25380.108/PACKAGE.md
vendored
Normal file
89
.nuget/packages/microsoft.extensions.caching.memory/10.0.0-preview.7.25380.108/PACKAGE.md
vendored
Normal file
@@ -0,0 +1,89 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
Provides implementations for local and distributed in-memory cache. It stores and retrieves data in a fast and efficient way.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* A concrete implementation of the IMemoryCache interface, which represents a local in-memory cache that stores and retrieves data in a fast and efficient way
|
||||
* A distributed cache that supports higher scale-out than local cache
|
||||
* Expiration and eviction policies for its entries
|
||||
* Entry prioritization for when the cache size limit is exceeded and needs to be compacted by entry eviction
|
||||
* Track of cache statictics
|
||||
|
||||
## How to Use
|
||||
|
||||
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
|
||||
|
||||
Use Microsoft.Extensions.Caching.Memory over System.Runtime.Caching when working with ASP.NET Core as it provides better integration support. For example, IMemoryCache works natively with ASP.NET Core dependency injection.
|
||||
|
||||
Local in-memory serialization:
|
||||
```csharp
|
||||
using Microsoft.Extensions.Caching.Memory;
|
||||
|
||||
using MemoryCache cache = new(new MemoryCacheOptions());
|
||||
|
||||
object valueToCache = new();
|
||||
string key = "key";
|
||||
|
||||
using (ICacheEntry entry = cache.CreateEntry(key))
|
||||
{
|
||||
// Entries are committed after they are disposed therefore it does not exist yet.
|
||||
Console.WriteLine($"Exists: {cache.TryGetValue(key, out _)}\n");
|
||||
|
||||
entry.Value = valueToCache;
|
||||
entry.SlidingExpiration = TimeSpan.FromSeconds(2);
|
||||
}
|
||||
|
||||
bool exists = cache.TryGetValue(key, out object? cachedValue);
|
||||
Console.WriteLine($"Exists: {exists}" );
|
||||
Console.WriteLine($"cachedValue is valueToCache? {object.ReferenceEquals(cachedValue, valueToCache)}\n");
|
||||
|
||||
Console.WriteLine("Wait for the sliding expiration...");
|
||||
Thread.Sleep(TimeSpan.FromSeconds(2));
|
||||
|
||||
Console.WriteLine("Exists: " + cache.TryGetValue(key, out _));
|
||||
|
||||
// You can also use the acceleration extensions to set and get entries
|
||||
string key2 = "key2";
|
||||
object value2 = new();
|
||||
|
||||
cache.Set("key2", value2);
|
||||
|
||||
object? cachedValue2 = cache.Get(key2);
|
||||
Console.WriteLine($"cachedValue2 is value2? {object.ReferenceEquals(cachedValue2, value2)}");
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `Microsoft.Extensions.Caching.Memory.MemoryCache`
|
||||
* `Microsoft.Extensions.Caching.Memory.MemoryCacheOptions`
|
||||
* `Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache`
|
||||
* `Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
|
||||
|
||||
* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/caching)
|
||||
* [Cache in-memory in ASP.NET Core](https://learn.microsoft.com/aspnet/core/performance/caching/memory)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.caching.memory)
|
||||
|
||||
## Related Packages
|
||||
|
||||
<!-- The related packages associated with this package -->
|
||||
|
||||
[Microsoft.Extensions.Caching.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Caching.Abstractions)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.Extensions.Caching.Memory is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
1418
.nuget/packages/microsoft.extensions.caching.memory/10.0.0-preview.7.25380.108/THIRD-PARTY-NOTICES.TXT
vendored
Normal file
1418
.nuget/packages/microsoft.extensions.caching.memory/10.0.0-preview.7.25380.108/THIRD-PARTY-NOTICES.TXT
vendored
Normal file
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Caching_Memory_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Caching_Memory_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Caching.Memory 10.0.0-preview.7.25380.108 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Caching_Memory_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Caching_Memory_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Caching.Memory 10.0.0-preview.7.25380.108 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,362 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Caching.Memory</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.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.CacheEntry.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.CacheEntry.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.CacheEntry.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="T:Microsoft.Extensions.Caching.Memory.MemoryCache">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> using a dictionary to
|
||||
store its entries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
<param name="loggerFactory">The factory used to create loggers.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Finalize">
|
||||
<summary>
|
||||
Cleans up the background collection events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Count">
|
||||
<summary>
|
||||
Gets the count of the current entries for diagnostic purposes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Keys">
|
||||
<summary>
|
||||
Gets an enumerable of the all the keys in the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Size">
|
||||
<summary>
|
||||
Internal accessor for Size for testing only.
|
||||
|
||||
Note that this is only eventually consistent with the contents of the collection.
|
||||
See comment on <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.CreateEntry(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue(System.Object,System.Object@)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue(System.ReadOnlySpan{System.Char},System.Object@)">
|
||||
<summary>
|
||||
Gets the item associated with this key if present.
|
||||
</summary>
|
||||
<param name="key">A character span corresponding to a <see cref="T:System.String"/> identifying the requested entry.</param>
|
||||
<param name="value">The located value or null.</param>
|
||||
<returns>True if the key was found.</returns>
|
||||
<remarks>This method allows values with <see cref="T:System.String"/> keys to be queried by content without allocating a new <see cref="T:System.String"/> instance.</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue``1(System.ReadOnlySpan{System.Char},``0@)">
|
||||
<summary>
|
||||
Gets the item associated with this key if present.
|
||||
</summary>
|
||||
<param name="key">A character span corresponding to a <see cref="T:System.String"/> identifying the requested entry.</param>
|
||||
<param name="value">The located value or null.</param>
|
||||
<returns>True if the key was found.</returns>
|
||||
<remarks>This method allows values with <see cref="T:System.String"/> keys to be queried by content without allocating a new <see cref="T:System.String"/> instance.</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Remove(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Clear">
|
||||
<summary>
|
||||
Removes all keys and values from the cache.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.GetCurrentStatistics">
|
||||
<summary>
|
||||
Gets a snapshot of the current statistics for the memory cache.
|
||||
</summary>
|
||||
<returns>Returns <see langword="null"/> if statistics are not being tracked because <see cref="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics" /> is <see langword="false"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.UpdateCacheSizeExceedsCapacity(Microsoft.Extensions.Caching.Memory.CacheEntry,Microsoft.Extensions.Caching.Memory.CacheEntry,Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState)">
|
||||
<summary>
|
||||
Determines if increasing the cache size by the size of the
|
||||
entry would cause it to exceed any size limit on the cache.
|
||||
</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if increasing the cache size would
|
||||
cause it to exceed the size limit; otherwise, <see langword="false" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Compact(System.Double)">
|
||||
Remove at least the given percentage (0.10 for 10%) of the total entries (or estimated memory?), according to the following policy:
|
||||
1. Remove all expired items.
|
||||
2. Bucket by CacheItemPriority.
|
||||
3. Least recently used objects.
|
||||
?. Items with the soonest absolute expiration.
|
||||
?. Items with the soonest sliding expiration.
|
||||
?. Larger objects - estimated by object graph size, inaccurate.
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposes the cache and clears all entries.
|
||||
</summary>
|
||||
<param name="disposing"><see langword="true" /> to dispose the object resources; <see langword="false" /> to take no action.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState">
|
||||
<summary>
|
||||
Wrapper for the memory cache entries collection.
|
||||
|
||||
Entries may have various sizes. If a size limit has been set, the cache keeps track of the aggregate of all the entries' sizes
|
||||
in order to trigger compaction when the size limit is exceeded.
|
||||
|
||||
For performance reasons, the size is not updated atomically with the collection, but is only made eventually consistent.
|
||||
|
||||
When the memory cache is cleared, it replaces the backing collection entirely. This may occur in parallel with operations
|
||||
like add, set, remove, and compact which may modify the collection and thus its overall size.
|
||||
|
||||
To keep the overall size eventually consistent, therefore, the collection and the overall size are wrapped in this CoherentState
|
||||
object. Individual operations take a local reference to this wrapper object while they work, and make size updates to this object.
|
||||
Clearing the cache simply replaces the object, so that any still in progress updates do not affect the overall size value for
|
||||
the new backing collection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions">
|
||||
<summary>
|
||||
Specifies options for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.Clock">
|
||||
<summary>
|
||||
Gets or sets the clock used by the cache for expiration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.ExpirationScanFrequency">
|
||||
<summary>
|
||||
Gets or sets the minimum length of time between successive scans for expired items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.SizeLimit">
|
||||
<summary>
|
||||
Gets or sets the maximum size of the cache.
|
||||
</summary>
|
||||
<remarks>
|
||||
The units are arbitrary. Users specify the size of every entry they add to the cache.
|
||||
If no size is specified, the entry has no size and the size limit is ignored for that entry.
|
||||
For more information, see
|
||||
<see href="https://learn.microsoft.com/aspnet/core/performance/caching/memory#use-setsize-size-and-sizelimit-to-limit-cache-size">Use SetSize, Size, and SizeLimit to limit cache size</see>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactOnMemoryPressure">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether the cache is compacted when the maximum size is exceeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactionPercentage">
|
||||
<summary>
|
||||
Gets or sets the amount the cache is compacted by when the maximum size is exceeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackLinkedCacheEntries">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether linked entries are tracked.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true"/> if linked entries are tracked; otherwise, <see langword="false" />.
|
||||
The default is <see langword="false" />.
|
||||
</value>
|
||||
<remarks>Prior to .NET 7, this feature was always enabled.</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether memory cache statistics are tracked.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true"/> if memory cache statistics are tracked; otherwise, <see langword="false" />.
|
||||
The default is <see langword="false" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions">
|
||||
<summary>
|
||||
Specifies options for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> using <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
<param name="loggerFactory">The logger factory to create <see cref="T:Microsoft.Extensions.Logging.ILogger"/> used to log messages.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Get(System.String)">
|
||||
<summary>
|
||||
Gets the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to get.</param>
|
||||
<returns>The byte array value of the key.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.GetAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously gets the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to get.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for getting the byte array value associated with the specified key from the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)">
|
||||
<summary>
|
||||
Sets the specified item associated with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to set.</param>
|
||||
<param name="value">The byte array value of the item to set.</param>
|
||||
<param name="options">The cache options for the item to set.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.SetAsync(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously sets the specified item associated with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to set.</param>
|
||||
<param name="value">The byte array value of the item to set.</param>
|
||||
<param name="options">The cache options for the item to set.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for setting the byte array value associated with the specified key in the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Refresh(System.String)">
|
||||
<summary>
|
||||
Refreshes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to refresh.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.RefreshAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously refreshes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to refresh.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for refreshing the specified key in the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Remove(System.String)">
|
||||
<summary>
|
||||
Removes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to remove.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.RemoveAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously removes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to remove.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for removing the specified key from the cache.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up memory cache related services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a non distributed in-memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
|
||||
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
|
||||
<summary>
|
||||
Adds a non distributed in-memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
|
||||
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="setupAction">
|
||||
The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions"/>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
|
||||
to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
|
||||
can safely add this dependency as part of their dependency list to ensure that there is at least
|
||||
one implementation available.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
|
||||
server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
|
||||
For those scenarios it is recommended to use a proper distributed cache that can expand across
|
||||
multiple machines.
|
||||
</remarks>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
|
||||
<summary>
|
||||
Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
|
||||
to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
|
||||
can safely add this dependency as part of their dependency list to ensure that there is at least
|
||||
one implementation available.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
|
||||
server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
|
||||
For those scenarios it is recommended to use a proper distributed cache that can expand across
|
||||
multiple machines.
|
||||
</remarks>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="setupAction">
|
||||
The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.CacheEntryHasEmptySize">
|
||||
<summary>Cache entry must specify a value for {0} when {1} is set.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,537 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Caching.Memory</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.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.CacheEntry.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.CacheEntry.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.CacheEntry.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="T:Microsoft.Extensions.Caching.Memory.MemoryCache">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> using a dictionary to
|
||||
store its entries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
<param name="loggerFactory">The factory used to create loggers.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Finalize">
|
||||
<summary>
|
||||
Cleans up the background collection events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Count">
|
||||
<summary>
|
||||
Gets the count of the current entries for diagnostic purposes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Keys">
|
||||
<summary>
|
||||
Gets an enumerable of the all the keys in the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Size">
|
||||
<summary>
|
||||
Internal accessor for Size for testing only.
|
||||
|
||||
Note that this is only eventually consistent with the contents of the collection.
|
||||
See comment on <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.CreateEntry(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue(System.Object,System.Object@)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Remove(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Clear">
|
||||
<summary>
|
||||
Removes all keys and values from the cache.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.GetCurrentStatistics">
|
||||
<summary>
|
||||
Gets a snapshot of the current statistics for the memory cache.
|
||||
</summary>
|
||||
<returns>Returns <see langword="null"/> if statistics are not being tracked because <see cref="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics" /> is <see langword="false"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.UpdateCacheSizeExceedsCapacity(Microsoft.Extensions.Caching.Memory.CacheEntry,Microsoft.Extensions.Caching.Memory.CacheEntry,Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState)">
|
||||
<summary>
|
||||
Determines if increasing the cache size by the size of the
|
||||
entry would cause it to exceed any size limit on the cache.
|
||||
</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if increasing the cache size would
|
||||
cause it to exceed the size limit; otherwise, <see langword="false" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Compact(System.Double)">
|
||||
Remove at least the given percentage (0.10 for 10%) of the total entries (or estimated memory?), according to the following policy:
|
||||
1. Remove all expired items.
|
||||
2. Bucket by CacheItemPriority.
|
||||
3. Least recently used objects.
|
||||
?. Items with the soonest absolute expiration.
|
||||
?. Items with the soonest sliding expiration.
|
||||
?. Larger objects - estimated by object graph size, inaccurate.
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposes the cache and clears all entries.
|
||||
</summary>
|
||||
<param name="disposing"><see langword="true" /> to dispose the object resources; <see langword="false" /> to take no action.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState">
|
||||
<summary>
|
||||
Wrapper for the memory cache entries collection.
|
||||
|
||||
Entries may have various sizes. If a size limit has been set, the cache keeps track of the aggregate of all the entries' sizes
|
||||
in order to trigger compaction when the size limit is exceeded.
|
||||
|
||||
For performance reasons, the size is not updated atomically with the collection, but is only made eventually consistent.
|
||||
|
||||
When the memory cache is cleared, it replaces the backing collection entirely. This may occur in parallel with operations
|
||||
like add, set, remove, and compact which may modify the collection and thus its overall size.
|
||||
|
||||
To keep the overall size eventually consistent, therefore, the collection and the overall size are wrapped in this CoherentState
|
||||
object. Individual operations take a local reference to this wrapper object while they work, and make size updates to this object.
|
||||
Clearing the cache simply replaces the object, so that any still in progress updates do not affect the overall size value for
|
||||
the new backing collection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions">
|
||||
<summary>
|
||||
Specifies options for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.Clock">
|
||||
<summary>
|
||||
Gets or sets the clock used by the cache for expiration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.ExpirationScanFrequency">
|
||||
<summary>
|
||||
Gets or sets the minimum length of time between successive scans for expired items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.SizeLimit">
|
||||
<summary>
|
||||
Gets or sets the maximum size of the cache.
|
||||
</summary>
|
||||
<remarks>
|
||||
The units are arbitrary. Users specify the size of every entry they add to the cache.
|
||||
If no size is specified, the entry has no size and the size limit is ignored for that entry.
|
||||
For more information, see
|
||||
<see href="https://learn.microsoft.com/aspnet/core/performance/caching/memory#use-setsize-size-and-sizelimit-to-limit-cache-size">Use SetSize, Size, and SizeLimit to limit cache size</see>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactOnMemoryPressure">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether the cache is compacted when the maximum size is exceeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactionPercentage">
|
||||
<summary>
|
||||
Gets or sets the amount the cache is compacted by when the maximum size is exceeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackLinkedCacheEntries">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether linked entries are tracked.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true"/> if linked entries are tracked; otherwise, <see langword="false" />.
|
||||
The default is <see langword="false" />.
|
||||
</value>
|
||||
<remarks>Prior to .NET 7, this feature was always enabled.</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether memory cache statistics are tracked.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true"/> if memory cache statistics are tracked; otherwise, <see langword="false" />.
|
||||
The default is <see langword="false" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions">
|
||||
<summary>
|
||||
Specifies options for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> using <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
<param name="loggerFactory">The logger factory to create <see cref="T:Microsoft.Extensions.Logging.ILogger"/> used to log messages.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Get(System.String)">
|
||||
<summary>
|
||||
Gets the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to get.</param>
|
||||
<returns>The byte array value of the key.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.GetAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously gets the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to get.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for getting the byte array value associated with the specified key from the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)">
|
||||
<summary>
|
||||
Sets the specified item associated with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to set.</param>
|
||||
<param name="value">The byte array value of the item to set.</param>
|
||||
<param name="options">The cache options for the item to set.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.SetAsync(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously sets the specified item associated with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to set.</param>
|
||||
<param name="value">The byte array value of the item to set.</param>
|
||||
<param name="options">The cache options for the item to set.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for setting the byte array value associated with the specified key in the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Refresh(System.String)">
|
||||
<summary>
|
||||
Refreshes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to refresh.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.RefreshAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously refreshes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to refresh.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for refreshing the specified key in the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Remove(System.String)">
|
||||
<summary>
|
||||
Removes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to remove.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.RemoveAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously removes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to remove.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for removing the specified key from the cache.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up memory cache related services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a non distributed in-memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
|
||||
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
|
||||
<summary>
|
||||
Adds a non distributed in-memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
|
||||
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="setupAction">
|
||||
The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions"/>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
|
||||
to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
|
||||
can safely add this dependency as part of their dependency list to ensure that there is at least
|
||||
one implementation available.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
|
||||
server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
|
||||
For those scenarios it is recommended to use a proper distributed cache that can expand across
|
||||
multiple machines.
|
||||
</remarks>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
|
||||
<summary>
|
||||
Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
|
||||
to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
|
||||
can safely add this dependency as part of their dependency list to ensure that there is at least
|
||||
one implementation available.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
|
||||
server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
|
||||
For those scenarios it is recommended to use a proper distributed cache that can expand across
|
||||
multiple machines.
|
||||
</remarks>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="setupAction">
|
||||
The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:System.Marvin.ComputeHash32(System.ReadOnlySpan{System.Byte},System.UInt64)">
|
||||
<summary>
|
||||
Compute a Marvin hash and collapse it into a 32-bit hash.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Marvin.ComputeHash32(System.Byte@,System.UInt32,System.UInt32,System.UInt32)">
|
||||
<summary>
|
||||
Compute a Marvin hash and collapse it into a 32-bit hash.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.CacheEntryHasEmptySize">
|
||||
<summary>Cache entry must specify a value for {0} when {1} is set.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,344 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Caching.Memory</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.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.CacheEntry.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.CacheEntry.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.CacheEntry.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="T:Microsoft.Extensions.Caching.Memory.MemoryCache">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> using a dictionary to
|
||||
store its entries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
<param name="loggerFactory">The factory used to create loggers.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Finalize">
|
||||
<summary>
|
||||
Cleans up the background collection events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Count">
|
||||
<summary>
|
||||
Gets the count of the current entries for diagnostic purposes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Keys">
|
||||
<summary>
|
||||
Gets an enumerable of the all the keys in the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Size">
|
||||
<summary>
|
||||
Internal accessor for Size for testing only.
|
||||
|
||||
Note that this is only eventually consistent with the contents of the collection.
|
||||
See comment on <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.CreateEntry(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue(System.Object,System.Object@)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Remove(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Clear">
|
||||
<summary>
|
||||
Removes all keys and values from the cache.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.GetCurrentStatistics">
|
||||
<summary>
|
||||
Gets a snapshot of the current statistics for the memory cache.
|
||||
</summary>
|
||||
<returns>Returns <see langword="null"/> if statistics are not being tracked because <see cref="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics" /> is <see langword="false"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.UpdateCacheSizeExceedsCapacity(Microsoft.Extensions.Caching.Memory.CacheEntry,Microsoft.Extensions.Caching.Memory.CacheEntry,Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState)">
|
||||
<summary>
|
||||
Determines if increasing the cache size by the size of the
|
||||
entry would cause it to exceed any size limit on the cache.
|
||||
</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if increasing the cache size would
|
||||
cause it to exceed the size limit; otherwise, <see langword="false" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Compact(System.Double)">
|
||||
Remove at least the given percentage (0.10 for 10%) of the total entries (or estimated memory?), according to the following policy:
|
||||
1. Remove all expired items.
|
||||
2. Bucket by CacheItemPriority.
|
||||
3. Least recently used objects.
|
||||
?. Items with the soonest absolute expiration.
|
||||
?. Items with the soonest sliding expiration.
|
||||
?. Larger objects - estimated by object graph size, inaccurate.
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposes the cache and clears all entries.
|
||||
</summary>
|
||||
<param name="disposing"><see langword="true" /> to dispose the object resources; <see langword="false" /> to take no action.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState">
|
||||
<summary>
|
||||
Wrapper for the memory cache entries collection.
|
||||
|
||||
Entries may have various sizes. If a size limit has been set, the cache keeps track of the aggregate of all the entries' sizes
|
||||
in order to trigger compaction when the size limit is exceeded.
|
||||
|
||||
For performance reasons, the size is not updated atomically with the collection, but is only made eventually consistent.
|
||||
|
||||
When the memory cache is cleared, it replaces the backing collection entirely. This may occur in parallel with operations
|
||||
like add, set, remove, and compact which may modify the collection and thus its overall size.
|
||||
|
||||
To keep the overall size eventually consistent, therefore, the collection and the overall size are wrapped in this CoherentState
|
||||
object. Individual operations take a local reference to this wrapper object while they work, and make size updates to this object.
|
||||
Clearing the cache simply replaces the object, so that any still in progress updates do not affect the overall size value for
|
||||
the new backing collection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions">
|
||||
<summary>
|
||||
Specifies options for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.Clock">
|
||||
<summary>
|
||||
Gets or sets the clock used by the cache for expiration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.ExpirationScanFrequency">
|
||||
<summary>
|
||||
Gets or sets the minimum length of time between successive scans for expired items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.SizeLimit">
|
||||
<summary>
|
||||
Gets or sets the maximum size of the cache.
|
||||
</summary>
|
||||
<remarks>
|
||||
The units are arbitrary. Users specify the size of every entry they add to the cache.
|
||||
If no size is specified, the entry has no size and the size limit is ignored for that entry.
|
||||
For more information, see
|
||||
<see href="https://learn.microsoft.com/aspnet/core/performance/caching/memory#use-setsize-size-and-sizelimit-to-limit-cache-size">Use SetSize, Size, and SizeLimit to limit cache size</see>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactOnMemoryPressure">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether the cache is compacted when the maximum size is exceeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactionPercentage">
|
||||
<summary>
|
||||
Gets or sets the amount the cache is compacted by when the maximum size is exceeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackLinkedCacheEntries">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether linked entries are tracked.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true"/> if linked entries are tracked; otherwise, <see langword="false" />.
|
||||
The default is <see langword="false" />.
|
||||
</value>
|
||||
<remarks>Prior to .NET 7, this feature was always enabled.</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether memory cache statistics are tracked.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true"/> if memory cache statistics are tracked; otherwise, <see langword="false" />.
|
||||
The default is <see langword="false" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions">
|
||||
<summary>
|
||||
Specifies options for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> using <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
<param name="loggerFactory">The logger factory to create <see cref="T:Microsoft.Extensions.Logging.ILogger"/> used to log messages.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Get(System.String)">
|
||||
<summary>
|
||||
Gets the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to get.</param>
|
||||
<returns>The byte array value of the key.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.GetAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously gets the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to get.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for getting the byte array value associated with the specified key from the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)">
|
||||
<summary>
|
||||
Sets the specified item associated with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to set.</param>
|
||||
<param name="value">The byte array value of the item to set.</param>
|
||||
<param name="options">The cache options for the item to set.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.SetAsync(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously sets the specified item associated with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to set.</param>
|
||||
<param name="value">The byte array value of the item to set.</param>
|
||||
<param name="options">The cache options for the item to set.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for setting the byte array value associated with the specified key in the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Refresh(System.String)">
|
||||
<summary>
|
||||
Refreshes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to refresh.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.RefreshAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously refreshes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to refresh.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for refreshing the specified key in the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Remove(System.String)">
|
||||
<summary>
|
||||
Removes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to remove.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.RemoveAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously removes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to remove.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for removing the specified key from the cache.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up memory cache related services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a non distributed in-memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
|
||||
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
|
||||
<summary>
|
||||
Adds a non distributed in-memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
|
||||
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="setupAction">
|
||||
The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions"/>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
|
||||
to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
|
||||
can safely add this dependency as part of their dependency list to ensure that there is at least
|
||||
one implementation available.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
|
||||
server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
|
||||
For those scenarios it is recommended to use a proper distributed cache that can expand across
|
||||
multiple machines.
|
||||
</remarks>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
|
||||
<summary>
|
||||
Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
|
||||
to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
|
||||
can safely add this dependency as part of their dependency list to ensure that there is at least
|
||||
one implementation available.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
|
||||
server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
|
||||
For those scenarios it is recommended to use a proper distributed cache that can expand across
|
||||
multiple machines.
|
||||
</remarks>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="setupAction">
|
||||
The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.CacheEntryHasEmptySize">
|
||||
<summary>Cache entry must specify a value for {0} when {1} is set.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,362 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Caching.Memory</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.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.CacheEntry.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.CacheEntry.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.CacheEntry.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="T:Microsoft.Extensions.Caching.Memory.MemoryCache">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> using a dictionary to
|
||||
store its entries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
<param name="loggerFactory">The factory used to create loggers.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Finalize">
|
||||
<summary>
|
||||
Cleans up the background collection events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Count">
|
||||
<summary>
|
||||
Gets the count of the current entries for diagnostic purposes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Keys">
|
||||
<summary>
|
||||
Gets an enumerable of the all the keys in the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Size">
|
||||
<summary>
|
||||
Internal accessor for Size for testing only.
|
||||
|
||||
Note that this is only eventually consistent with the contents of the collection.
|
||||
See comment on <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.CreateEntry(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue(System.Object,System.Object@)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue(System.ReadOnlySpan{System.Char},System.Object@)">
|
||||
<summary>
|
||||
Gets the item associated with this key if present.
|
||||
</summary>
|
||||
<param name="key">A character span corresponding to a <see cref="T:System.String"/> identifying the requested entry.</param>
|
||||
<param name="value">The located value or null.</param>
|
||||
<returns>True if the key was found.</returns>
|
||||
<remarks>This method allows values with <see cref="T:System.String"/> keys to be queried by content without allocating a new <see cref="T:System.String"/> instance.</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue``1(System.ReadOnlySpan{System.Char},``0@)">
|
||||
<summary>
|
||||
Gets the item associated with this key if present.
|
||||
</summary>
|
||||
<param name="key">A character span corresponding to a <see cref="T:System.String"/> identifying the requested entry.</param>
|
||||
<param name="value">The located value or null.</param>
|
||||
<returns>True if the key was found.</returns>
|
||||
<remarks>This method allows values with <see cref="T:System.String"/> keys to be queried by content without allocating a new <see cref="T:System.String"/> instance.</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Remove(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Clear">
|
||||
<summary>
|
||||
Removes all keys and values from the cache.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.GetCurrentStatistics">
|
||||
<summary>
|
||||
Gets a snapshot of the current statistics for the memory cache.
|
||||
</summary>
|
||||
<returns>Returns <see langword="null"/> if statistics are not being tracked because <see cref="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics" /> is <see langword="false"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.UpdateCacheSizeExceedsCapacity(Microsoft.Extensions.Caching.Memory.CacheEntry,Microsoft.Extensions.Caching.Memory.CacheEntry,Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState)">
|
||||
<summary>
|
||||
Determines if increasing the cache size by the size of the
|
||||
entry would cause it to exceed any size limit on the cache.
|
||||
</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if increasing the cache size would
|
||||
cause it to exceed the size limit; otherwise, <see langword="false" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Compact(System.Double)">
|
||||
Remove at least the given percentage (0.10 for 10%) of the total entries (or estimated memory?), according to the following policy:
|
||||
1. Remove all expired items.
|
||||
2. Bucket by CacheItemPriority.
|
||||
3. Least recently used objects.
|
||||
?. Items with the soonest absolute expiration.
|
||||
?. Items with the soonest sliding expiration.
|
||||
?. Larger objects - estimated by object graph size, inaccurate.
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposes the cache and clears all entries.
|
||||
</summary>
|
||||
<param name="disposing"><see langword="true" /> to dispose the object resources; <see langword="false" /> to take no action.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState">
|
||||
<summary>
|
||||
Wrapper for the memory cache entries collection.
|
||||
|
||||
Entries may have various sizes. If a size limit has been set, the cache keeps track of the aggregate of all the entries' sizes
|
||||
in order to trigger compaction when the size limit is exceeded.
|
||||
|
||||
For performance reasons, the size is not updated atomically with the collection, but is only made eventually consistent.
|
||||
|
||||
When the memory cache is cleared, it replaces the backing collection entirely. This may occur in parallel with operations
|
||||
like add, set, remove, and compact which may modify the collection and thus its overall size.
|
||||
|
||||
To keep the overall size eventually consistent, therefore, the collection and the overall size are wrapped in this CoherentState
|
||||
object. Individual operations take a local reference to this wrapper object while they work, and make size updates to this object.
|
||||
Clearing the cache simply replaces the object, so that any still in progress updates do not affect the overall size value for
|
||||
the new backing collection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions">
|
||||
<summary>
|
||||
Specifies options for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.Clock">
|
||||
<summary>
|
||||
Gets or sets the clock used by the cache for expiration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.ExpirationScanFrequency">
|
||||
<summary>
|
||||
Gets or sets the minimum length of time between successive scans for expired items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.SizeLimit">
|
||||
<summary>
|
||||
Gets or sets the maximum size of the cache.
|
||||
</summary>
|
||||
<remarks>
|
||||
The units are arbitrary. Users specify the size of every entry they add to the cache.
|
||||
If no size is specified, the entry has no size and the size limit is ignored for that entry.
|
||||
For more information, see
|
||||
<see href="https://learn.microsoft.com/aspnet/core/performance/caching/memory#use-setsize-size-and-sizelimit-to-limit-cache-size">Use SetSize, Size, and SizeLimit to limit cache size</see>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactOnMemoryPressure">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether the cache is compacted when the maximum size is exceeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactionPercentage">
|
||||
<summary>
|
||||
Gets or sets the amount the cache is compacted by when the maximum size is exceeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackLinkedCacheEntries">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether linked entries are tracked.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true"/> if linked entries are tracked; otherwise, <see langword="false" />.
|
||||
The default is <see langword="false" />.
|
||||
</value>
|
||||
<remarks>Prior to .NET 7, this feature was always enabled.</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether memory cache statistics are tracked.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true"/> if memory cache statistics are tracked; otherwise, <see langword="false" />.
|
||||
The default is <see langword="false" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions">
|
||||
<summary>
|
||||
Specifies options for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> using <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
<param name="loggerFactory">The logger factory to create <see cref="T:Microsoft.Extensions.Logging.ILogger"/> used to log messages.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Get(System.String)">
|
||||
<summary>
|
||||
Gets the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to get.</param>
|
||||
<returns>The byte array value of the key.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.GetAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously gets the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to get.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for getting the byte array value associated with the specified key from the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)">
|
||||
<summary>
|
||||
Sets the specified item associated with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to set.</param>
|
||||
<param name="value">The byte array value of the item to set.</param>
|
||||
<param name="options">The cache options for the item to set.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.SetAsync(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously sets the specified item associated with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to set.</param>
|
||||
<param name="value">The byte array value of the item to set.</param>
|
||||
<param name="options">The cache options for the item to set.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for setting the byte array value associated with the specified key in the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Refresh(System.String)">
|
||||
<summary>
|
||||
Refreshes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to refresh.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.RefreshAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously refreshes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to refresh.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for refreshing the specified key in the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Remove(System.String)">
|
||||
<summary>
|
||||
Removes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to remove.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.RemoveAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously removes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to remove.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for removing the specified key from the cache.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up memory cache related services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a non distributed in-memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
|
||||
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
|
||||
<summary>
|
||||
Adds a non distributed in-memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
|
||||
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="setupAction">
|
||||
The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions"/>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
|
||||
to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
|
||||
can safely add this dependency as part of their dependency list to ensure that there is at least
|
||||
one implementation available.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
|
||||
server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
|
||||
For those scenarios it is recommended to use a proper distributed cache that can expand across
|
||||
multiple machines.
|
||||
</remarks>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
|
||||
<summary>
|
||||
Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
|
||||
to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
|
||||
can safely add this dependency as part of their dependency list to ensure that there is at least
|
||||
one implementation available.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
|
||||
server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
|
||||
For those scenarios it is recommended to use a proper distributed cache that can expand across
|
||||
multiple machines.
|
||||
</remarks>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="setupAction">
|
||||
The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.CacheEntryHasEmptySize">
|
||||
<summary>Cache entry must specify a value for {0} when {1} is set.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,537 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Caching.Memory</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.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.CacheEntry.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.CacheEntry.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.CacheEntry.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="T:Microsoft.Extensions.Caching.Memory.MemoryCache">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> using a dictionary to
|
||||
store its entries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
<param name="loggerFactory">The factory used to create loggers.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Finalize">
|
||||
<summary>
|
||||
Cleans up the background collection events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Count">
|
||||
<summary>
|
||||
Gets the count of the current entries for diagnostic purposes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Keys">
|
||||
<summary>
|
||||
Gets an enumerable of the all the keys in the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Size">
|
||||
<summary>
|
||||
Internal accessor for Size for testing only.
|
||||
|
||||
Note that this is only eventually consistent with the contents of the collection.
|
||||
See comment on <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.CreateEntry(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue(System.Object,System.Object@)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Remove(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Clear">
|
||||
<summary>
|
||||
Removes all keys and values from the cache.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.GetCurrentStatistics">
|
||||
<summary>
|
||||
Gets a snapshot of the current statistics for the memory cache.
|
||||
</summary>
|
||||
<returns>Returns <see langword="null"/> if statistics are not being tracked because <see cref="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics" /> is <see langword="false"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.UpdateCacheSizeExceedsCapacity(Microsoft.Extensions.Caching.Memory.CacheEntry,Microsoft.Extensions.Caching.Memory.CacheEntry,Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState)">
|
||||
<summary>
|
||||
Determines if increasing the cache size by the size of the
|
||||
entry would cause it to exceed any size limit on the cache.
|
||||
</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if increasing the cache size would
|
||||
cause it to exceed the size limit; otherwise, <see langword="false" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Compact(System.Double)">
|
||||
Remove at least the given percentage (0.10 for 10%) of the total entries (or estimated memory?), according to the following policy:
|
||||
1. Remove all expired items.
|
||||
2. Bucket by CacheItemPriority.
|
||||
3. Least recently used objects.
|
||||
?. Items with the soonest absolute expiration.
|
||||
?. Items with the soonest sliding expiration.
|
||||
?. Larger objects - estimated by object graph size, inaccurate.
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposes the cache and clears all entries.
|
||||
</summary>
|
||||
<param name="disposing"><see langword="true" /> to dispose the object resources; <see langword="false" /> to take no action.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCache.CoherentState">
|
||||
<summary>
|
||||
Wrapper for the memory cache entries collection.
|
||||
|
||||
Entries may have various sizes. If a size limit has been set, the cache keeps track of the aggregate of all the entries' sizes
|
||||
in order to trigger compaction when the size limit is exceeded.
|
||||
|
||||
For performance reasons, the size is not updated atomically with the collection, but is only made eventually consistent.
|
||||
|
||||
When the memory cache is cleared, it replaces the backing collection entirely. This may occur in parallel with operations
|
||||
like add, set, remove, and compact which may modify the collection and thus its overall size.
|
||||
|
||||
To keep the overall size eventually consistent, therefore, the collection and the overall size are wrapped in this CoherentState
|
||||
object. Individual operations take a local reference to this wrapper object while they work, and make size updates to this object.
|
||||
Clearing the cache simply replaces the object, so that any still in progress updates do not affect the overall size value for
|
||||
the new backing collection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions">
|
||||
<summary>
|
||||
Specifies options for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.Clock">
|
||||
<summary>
|
||||
Gets or sets the clock used by the cache for expiration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.ExpirationScanFrequency">
|
||||
<summary>
|
||||
Gets or sets the minimum length of time between successive scans for expired items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.SizeLimit">
|
||||
<summary>
|
||||
Gets or sets the maximum size of the cache.
|
||||
</summary>
|
||||
<remarks>
|
||||
The units are arbitrary. Users specify the size of every entry they add to the cache.
|
||||
If no size is specified, the entry has no size and the size limit is ignored for that entry.
|
||||
For more information, see
|
||||
<see href="https://learn.microsoft.com/aspnet/core/performance/caching/memory#use-setsize-size-and-sizelimit-to-limit-cache-size">Use SetSize, Size, and SizeLimit to limit cache size</see>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactOnMemoryPressure">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether the cache is compacted when the maximum size is exceeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactionPercentage">
|
||||
<summary>
|
||||
Gets or sets the amount the cache is compacted by when the maximum size is exceeded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackLinkedCacheEntries">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether linked entries are tracked.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true"/> if linked entries are tracked; otherwise, <see langword="false" />.
|
||||
The default is <see langword="false" />.
|
||||
</value>
|
||||
<remarks>Prior to .NET 7, this feature was always enabled.</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether memory cache statistics are tracked.
|
||||
</summary>
|
||||
<value>
|
||||
<see langword="true"/> if memory cache statistics are tracked; otherwise, <see langword="false" />.
|
||||
The default is <see langword="false" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions">
|
||||
<summary>
|
||||
Specifies options for <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> using <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache"/> instance.
|
||||
</summary>
|
||||
<param name="optionsAccessor">The options of the cache.</param>
|
||||
<param name="loggerFactory">The logger factory to create <see cref="T:Microsoft.Extensions.Logging.ILogger"/> used to log messages.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Get(System.String)">
|
||||
<summary>
|
||||
Gets the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to get.</param>
|
||||
<returns>The byte array value of the key.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.GetAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously gets the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to get.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for getting the byte array value associated with the specified key from the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)">
|
||||
<summary>
|
||||
Sets the specified item associated with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to set.</param>
|
||||
<param name="value">The byte array value of the item to set.</param>
|
||||
<param name="options">The cache options for the item to set.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.SetAsync(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously sets the specified item associated with a key in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> as a byte array.
|
||||
</summary>
|
||||
<param name="key">The key of the item to set.</param>
|
||||
<param name="value">The byte array value of the item to set.</param>
|
||||
<param name="options">The cache options for the item to set.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for setting the byte array value associated with the specified key in the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Refresh(System.String)">
|
||||
<summary>
|
||||
Refreshes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to refresh.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.RefreshAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously refreshes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to refresh.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for refreshing the specified key in the cache.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.Remove(System.String)">
|
||||
<summary>
|
||||
Removes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to remove.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache.RemoveAsync(System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously removes the specified item associated with a key from the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the item to remove.</param>
|
||||
<param name="token">The <see cref="T:System.Threading.CancellationToken"/> to use to cancel operation.</param>
|
||||
<returns>The task for removing the specified key from the cache.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up memory cache related services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a non distributed in-memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
|
||||
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
|
||||
<summary>
|
||||
Adds a non distributed in-memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
|
||||
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="setupAction">
|
||||
The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions"/>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
|
||||
to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
|
||||
can safely add this dependency as part of their dependency list to ensure that there is at least
|
||||
one implementation available.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
|
||||
server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
|
||||
For those scenarios it is recommended to use a proper distributed cache that can expand across
|
||||
multiple machines.
|
||||
</remarks>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
|
||||
<summary>
|
||||
Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
|
||||
to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
|
||||
can safely add this dependency as part of their dependency list to ensure that there is at least
|
||||
one implementation available.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
|
||||
server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
|
||||
For those scenarios it is recommended to use a proper distributed cache that can expand across
|
||||
multiple machines.
|
||||
</remarks>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="setupAction">
|
||||
The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:System.Marvin.ComputeHash32(System.ReadOnlySpan{System.Byte},System.UInt64)">
|
||||
<summary>
|
||||
Compute a Marvin hash and collapse it into a 32-bit hash.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Marvin.ComputeHash32(System.Byte@,System.UInt32,System.UInt32,System.UInt32)">
|
||||
<summary>
|
||||
Compute a Marvin hash and collapse it into a 32-bit hash.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.CacheEntryHasEmptySize">
|
||||
<summary>Cache entry must specify a value for {0} when {1} is set.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
RaXLmEnLv2plJUnKomAnWZcDC0cXVn1/XO3XBqGxiC9fcT+aOzHHO43d0ovu4rlx5TSND0xWmTGakfOpOe+CzQ==
|
||||
Reference in New Issue
Block a user