MemoryCacheStatistics.xml

<Type Name="MemoryCacheStatistics" FullName="Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics">
  <TypeSignature Language="C#" Value="public class MemoryCacheStatistics" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MemoryCacheStatistics extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics" />
  <TypeSignature Language="VB.NET" Value="Public Class MemoryCacheStatistics" />
  <TypeSignature Language="F#" Value="type MemoryCacheStatistics = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class MemoryCacheStatistics" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Extensions.Caching.Abstractions</AssemblyName>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Holds a snapshot of statistics for a memory cache.</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MemoryCacheStatistics ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; MemoryCacheStatistics();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Caching.Abstractions</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes an instance of the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics" /> class.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CurrentEntryCount">
      <MemberSignature Language="C#" Value="public long CurrentEntryCount { get; init; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 CurrentEntryCount" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.CurrentEntryCount" />
      <MemberSignature Language="VB.NET" Value="Public Property CurrentEntryCount As Long" />
      <MemberSignature Language="F#" Value="member this.CurrentEntryCount : int64 with get, set" Usage="Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.CurrentEntryCount" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property long CurrentEntryCount { long get(); void set(long value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Caching.Abstractions</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the number of <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry" /> instances currently in the memory cache.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CurrentEstimatedSize">
      <MemberSignature Language="C#" Value="public long? CurrentEstimatedSize { get; init; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int64&gt; CurrentEstimatedSize" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.CurrentEstimatedSize" />
      <MemberSignature Language="VB.NET" Value="Public Property CurrentEstimatedSize As Nullable(Of Long)" />
      <MemberSignature Language="F#" Value="member this.CurrentEstimatedSize : Nullable&lt;int64&gt; with get, set" Usage="Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.CurrentEstimatedSize" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Nullable&lt;long&gt; CurrentEstimatedSize { Nullable&lt;long&gt; get(); void set(Nullable&lt;long&gt; value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Caching.Abstractions</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int64&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets an estimated sum of all the <see cref="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Size" /> values currently in the memory cache.</summary>
        <value>Returns <see langword="null" /> if size isn't being tracked. The common MemoryCache implementation tracks size whenever a SizeLimit is set on the cache.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TotalHits">
      <MemberSignature Language="C#" Value="public long TotalHits { get; init; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 TotalHits" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.TotalHits" />
      <MemberSignature Language="VB.NET" Value="Public Property TotalHits As Long" />
      <MemberSignature Language="F#" Value="member this.TotalHits : int64 with get, set" Usage="Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.TotalHits" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property long TotalHits { long get(); void set(long value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Caching.Abstractions</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the total number of cache hits.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TotalMisses">
      <MemberSignature Language="C#" Value="public long TotalMisses { get; init; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 TotalMisses" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.TotalMisses" />
      <MemberSignature Language="VB.NET" Value="Public Property TotalMisses As Long" />
      <MemberSignature Language="F#" Value="member this.TotalMisses : int64 with get, set" Usage="Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics.TotalMisses" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property long TotalMisses { long get(); void set(long value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Caching.Abstractions</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the total number of cache misses.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>