Microsoft.Extensions.Caching.Memory.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Caching.Memory</name>
  5. </assembly>
  6. <members>
  7. <member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.AbsoluteExpiration">
  8. <summary>
  9. Gets or sets an absolute expiration date for the cache entry.
  10. </summary>
  11. </member>
  12. <member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.AbsoluteExpirationRelativeToNow">
  13. <summary>
  14. Gets or sets an absolute expiration time, relative to now.
  15. </summary>
  16. </member>
  17. <member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.SlidingExpiration">
  18. <summary>
  19. Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed.
  20. This will not extend the entry lifetime beyond the absolute expiration (if set).
  21. </summary>
  22. </member>
  23. <member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.ExpirationTokens">
  24. <summary>
  25. Gets the <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> instances which cause the cache entry to expire.
  26. </summary>
  27. </member>
  28. <member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.PostEvictionCallbacks">
  29. <summary>
  30. Gets or sets the callbacks will be fired after the cache entry is evicted from the cache.
  31. </summary>
  32. </member>
  33. <member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.Priority">
  34. <summary>
  35. Gets or sets the priority for keeping the cache entry in the cache during a
  36. memory pressure triggered cleanup. The default is <see cref="F:Microsoft.Extensions.Caching.Memory.CacheItemPriority.Normal"/>.
  37. </summary>
  38. </member>
  39. <member name="P:Microsoft.Extensions.Caching.Memory.CacheEntry.Size">
  40. <summary>
  41. Gets or sets the size of the cache entry value.
  42. </summary>
  43. </member>
  44. <member name="T:Microsoft.Extensions.Caching.Memory.MemoryCache">
  45. <summary>
  46. An implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> using a dictionary to
  47. store its entries.
  48. </summary>
  49. </member>
  50. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
  51. <summary>
  52. Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
  53. </summary>
  54. <param name="optionsAccessor">The options of the cache.</param>
  55. </member>
  56. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions},Microsoft.Extensions.Logging.ILoggerFactory)">
  57. <summary>
  58. Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
  59. </summary>
  60. <param name="optionsAccessor">The options of the cache.</param>
  61. <param name="loggerFactory">The factory used to create loggers.</param>
  62. </member>
  63. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Finalize">
  64. <summary>
  65. Cleans up the background collection events.
  66. </summary>
  67. </member>
  68. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Count">
  69. <summary>
  70. Gets the count of the current entries for diagnostic purposes.
  71. </summary>
  72. </member>
  73. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.CreateEntry(System.Object)">
  74. <inheritdoc />
  75. </member>
  76. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue(System.Object,System.Object@)">
  77. <inheritdoc />
  78. </member>
  79. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Remove(System.Object)">
  80. <inheritdoc />
  81. </member>
  82. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Compact(System.Double)">
  83. Remove at least the given percentage (0.10 for 10%) of the total entries (or estimated memory?), according to the following policy:
  84. 1. Remove all expired items.
  85. 2. Bucket by CacheItemPriority.
  86. 3. Least recently used objects.
  87. ?. Items with the soonest absolute expiration.
  88. ?. Items with the soonest sliding expiration.
  89. ?. Larger objects - estimated by object graph size, inaccurate.
  90. </member>
  91. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.ExpirePriorityBucket(System.Int64@,System.Int64,System.Func{Microsoft.Extensions.Caching.Memory.CacheEntry,System.Int64},System.Collections.Generic.List{Microsoft.Extensions.Caching.Memory.CacheEntry},System.Collections.Generic.List{Microsoft.Extensions.Caching.Memory.CacheEntry})">
  92. Policy:
  93. 1. Least recently used objects.
  94. ?. Items with the soonest absolute expiration.
  95. ?. Items with the soonest sliding expiration.
  96. ?. Larger objects - estimated by object graph size, inaccurate.
  97. </member>
  98. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.ExpirationScanFrequency">
  99. <summary>
  100. Gets or sets the minimum length of time between successive scans for expired items.
  101. </summary>
  102. </member>
  103. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.SizeLimit">
  104. <summary>
  105. Gets or sets the maximum size of the cache.
  106. </summary>
  107. </member>
  108. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.CompactionPercentage">
  109. <summary>
  110. Gets or sets the amount to compact the cache by when the maximum size is exceeded.
  111. </summary>
  112. </member>
  113. <member name="T:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions">
  114. <summary>
  115. Extension methods for setting up memory cache related services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  116. </summary>
  117. </member>
  118. <member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  119. <summary>
  120. Adds a non distributed in memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
  121. <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  122. </summary>
  123. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
  124. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  125. </member>
  126. <member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
  127. <summary>
  128. Adds a non distributed in memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
  129. <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  130. </summary>
  131. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
  132. <param name="setupAction">
  133. The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions"/>.
  134. </param>
  135. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  136. </member>
  137. <member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  138. <summary>
  139. Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
  140. to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
  141. can safely add this dependency as part of their dependency list to ensure that there is at least
  142. one implementation available.
  143. </summary>
  144. <remarks>
  145. <see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
  146. server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
  147. For those scenarios it is recommended to use a proper distributed cache that can expand across
  148. multiple machines.
  149. </remarks>
  150. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
  151. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  152. </member>
  153. <member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions})">
  154. <summary>
  155. Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
  156. to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
  157. can safely add this dependency as part of their dependency list to ensure that there is at least
  158. one implementation available.
  159. </summary>
  160. <remarks>
  161. <see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
  162. server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
  163. For those scenarios it is recommended to use a proper distributed cache that can expand across
  164. multiple machines.
  165. </remarks>
  166. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
  167. <param name="setupAction">
  168. The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions"/>.
  169. </param>
  170. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  171. </member>
  172. </members>
  173. </doc>