Class ConcurrentStatsCounter

java.lang.Object
com.github.benmanes.caffeine.cache.stats.ConcurrentStatsCounter
All Implemented Interfaces:
StatsCounter

public final class ConcurrentStatsCounter extends Object implements StatsCounter
A thread-safe StatsCounter implementation for use by Cache implementors.
  • Field Details

    • hitCount

      private final LongAdder hitCount
    • missCount

      private final LongAdder missCount
    • loadSuccessCount

      private final LongAdder loadSuccessCount
    • loadFailureCount

      private final LongAdder loadFailureCount
    • totalLoadTime

      private final LongAdder totalLoadTime
    • evictionCount

      private final LongAdder evictionCount
    • evictionWeight

      private final LongAdder evictionWeight
  • Constructor Details

    • ConcurrentStatsCounter

      public ConcurrentStatsCounter()
      Constructs an instance with all counts initialized to zero.
  • Method Details

    • recordHits

      public void recordHits(@Nonnegative int count)
      Description copied from interface: StatsCounter
      Records cache hits. This should be called when a cache request returns a cached value.
      Specified by:
      recordHits in interface StatsCounter
      Parameters:
      count - the number of hits to record
    • recordMisses

      public void recordMisses(@Nonnegative int count)
      Description copied from interface: StatsCounter
      Records cache misses. This should be called when a cache request returns a value that was not found in the cache. This method should be called by the loading thread, as well as by threads blocking on the load. Multiple concurrent calls to Cache lookup methods with the same key on an absent value should result in a single call to either recordLoadSuccess or recordLoadFailure and multiple calls to this method, despite all being served by the results of a single load operation.
      Specified by:
      recordMisses in interface StatsCounter
      Parameters:
      count - the number of misses to record
    • recordLoadSuccess

      public void recordLoadSuccess(@Nonnegative long loadTime)
      Description copied from interface: StatsCounter
      Records the successful load of a new entry. This should be called when a cache request causes an entry to be loaded, and the loading completes successfully. In contrast to StatsCounter.recordMisses(int), this method should only be called by the loading thread.
      Specified by:
      recordLoadSuccess in interface StatsCounter
      Parameters:
      loadTime - the number of nanoseconds the cache spent computing or retrieving the new value
    • recordLoadFailure

      public void recordLoadFailure(@Nonnegative long loadTime)
      Description copied from interface: StatsCounter
      Records the failed load of a new entry. This should be called when a cache request causes an entry to be loaded, but either no value is found or an exception is thrown while loading the entry. In contrast to StatsCounter.recordMisses(int), this method should only be called by the loading thread.
      Specified by:
      recordLoadFailure in interface StatsCounter
      Parameters:
      loadTime - the number of nanoseconds the cache spent computing or retrieving the new value prior to discovering the value doesn't exist or an exception being thrown
    • recordEviction

      public void recordEviction()
      Description copied from interface: StatsCounter
      Records the eviction of an entry from the cache. This should only been called when an entry is evicted due to the cache's eviction strategy, and not as a result of manual invalidations.
      Specified by:
      recordEviction in interface StatsCounter
    • recordEviction

      public void recordEviction(int weight)
      Description copied from interface: StatsCounter
      Records the eviction of an entry from the cache. This should only been called when an entry is evicted due to the cache's eviction strategy, and not as a result of manual invalidations.
      Specified by:
      recordEviction in interface StatsCounter
      Parameters:
      weight - the weight of the evicted entry
    • snapshot

      public CacheStats snapshot()
      Description copied from interface: StatsCounter
      Returns a snapshot of this counter's values. Note that this may be an inconsistent view, as it may be interleaved with update operations.
      Specified by:
      snapshot in interface StatsCounter
      Returns:
      a snapshot of this counter's values
    • incrementBy

      public void incrementBy(@Nonnull StatsCounter other)
      Increments all counters by the values in other.
      Parameters:
      other - the counter to increment from
    • toString

      public String toString()
      Overrides:
      toString in class Object