Microsoft.Extensions.Caching.Memory.xml 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  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="T:Microsoft.Extensions.Caching.Memory.MemoryCache">
  40. <summary>
  41. An implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> using a dictionary to
  42. store its entries.
  43. </summary>
  44. </member>
  45. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
  46. <summary>
  47. Creates a new <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCache"/> instance.
  48. </summary>
  49. <param name="optionsAccessor">The options of the cache.</param>
  50. </member>
  51. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Finalize">
  52. <summary>
  53. Cleans up the background collection events.
  54. </summary>
  55. </member>
  56. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCache.Count">
  57. <summary>
  58. Gets the count of the current entries for diagnostic purposes.
  59. </summary>
  60. </member>
  61. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.CreateEntry(System.Object)">
  62. <inheritdoc />
  63. </member>
  64. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.TryGetValue(System.Object,System.Object@)">
  65. <inheritdoc />
  66. </member>
  67. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Remove(System.Object)">
  68. <inheritdoc />
  69. </member>
  70. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.DoMemoryPreassureCollection(System.Object)">
  71. This is called after a Gen2 garbage collection. We assume this means there was memory pressure.
  72. Remove at least 10% of the total entries (or estimated memory?).
  73. </member>
  74. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.Compact(System.Double)">
  75. Remove at least the given percentage (0.10 for 10%) of the total entries (or estimated memory?), according to the following policy:
  76. 1. Remove all expired items.
  77. 2. Bucket by CacheItemPriority.
  78. ?. Least recently used objects.
  79. ?. Items with the soonest absolute expiration.
  80. ?. Items with the soonest sliding expiration.
  81. ?. Larger objects - estimated by object graph size, inaccurate.
  82. </member>
  83. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCache.ExpirePriorityBucket(System.Int32,System.Collections.Generic.List{Microsoft.Extensions.Caching.Memory.CacheEntry},System.Collections.Generic.List{Microsoft.Extensions.Caching.Memory.CacheEntry})">
  84. Policy:
  85. ?. Least recently used objects.
  86. ?. Items with the soonest absolute expiration.
  87. ?. Items with the soonest sliding expiration.
  88. ?. Larger objects - estimated by object graph size, inaccurate.
  89. </member>
  90. <member name="T:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions">
  91. <summary>
  92. Extension methods for setting up memory cache related services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  93. </summary>
  94. </member>
  95. <member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  96. <summary>
  97. Adds a non distributed in memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
  98. <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  99. </summary>
  100. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
  101. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  102. </member>
  103. <member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Caching.Memory.MemoryCacheOptions})">
  104. <summary>
  105. Adds a non distributed in memory implementation of <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> to the
  106. <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  107. </summary>
  108. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
  109. <param name="setupAction">
  110. The <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions"/>.
  111. </param>
  112. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  113. </member>
  114. <member name="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  115. <summary>
  116. Adds a default implementation of <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> that stores items in memory
  117. to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. Frameworks that require a distributed cache to work
  118. can safely add this dependency as part of their dependency list to ensure that there is at least
  119. one implementation available.
  120. </summary>
  121. <remarks>
  122. <see cref="M:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddDistributedMemoryCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/> should only be used in single
  123. server scenarios as this cache stores items in memory and doesn't expand across multiple machines.
  124. For those scenarios it is recommended to use a proper distributed cache that can expand across
  125. multiple machines.
  126. </remarks>
  127. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
  128. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  129. </member>
  130. <member name="T:Microsoft.Extensions.Internal.GcNotification">
  131. <summary>
  132. Registers a callback that fires each time a Gen2 garbage collection occurs,
  133. presumably due to memory pressure.
  134. For this to work no components can have a reference to the instance.
  135. </summary>
  136. </member>
  137. </members>
  138. </doc>