org.opendaylight.infrautils.caches

Interface CacheStats

public interface CacheStats

Statistics about a Cache.

The data returned by this interface may not be 100% accurate, due to concurrency optimizations in implementations.

Author:

Michael Vorburger.ch

Method Summary

Modifier and Type	Method and Description
long	estimatedCurrentEntries() Number of key/value pair entries currently in the cache.
com.google.common.collect.ImmutableMap<String,Number>	extensions() Extensions provide implementation specific cache stats.
long	hitCount() Number of "hits" in the cache.
long	missCount() Number of "misses" in the cache.

Method Detail

estimatedCurrentEntries

long estimatedCurrentEntries()

Number of key/value pair entries currently in the cache.

missCount

long missCount()

Number of "misses" in the cache. A "miss" causes the CacheFunction to have to be invoked on a Cache.get(Object).

hitCount

long hitCount()

Number of "hits" in the cache. A "hit" is when a Cache can return from a Cache.get(Object) without having to use its CacheFunction.

extensions

com.google.common.collect.ImmutableMap<String,Number> extensions()

Extensions provide implementation specific cache stats. This is good enough for e.g. a CLI to dump and display to end-users.