Release 3.6.1.0

E18813-01

`#include <coherence/net/cache/CacheStatistics.hpp>`

Inherits Object.

Inherited by SimpleCacheStatistics` [virtual]`

.

## Public Types | |

typedef spec::Handle | Handle |

CacheStatistics Handle definition. | |

typedef spec::View | View |

CacheStatistics View definition. | |

typedef spec::Holder | Holder |

CacheStatistics Holder definition. | |

## Public Member Functions | |

virtual int64_t | getTotalGets () const =0 |

Determine the total number of get() operations since the cache statistics were last reset. | |

virtual int64_t | getTotalGetsMillis () const =0 |

Determine the total number of milliseconds spent on get() operations since the cache statistics were last reset. | |

virtual float64_t | getAverageGetMillis () const =0 |

Determine the average number of milliseconds per get() invocation since the cache statistics were last reset. | |

virtual int64_t | getTotalPuts () const =0 |

Determine the total number of put() operations since the cache statistics were last reset. | |

virtual int64_t | getTotalPutsMillis () const =0 |

Determine the total number of milliseconds spent on put() operations since the cache statistics were last reset. | |

virtual float64_t | getAveragePutMillis () const =0 |

Determine the average number of milliseconds per put() invocation since the cache statistics were last reset. | |

virtual int64_t | getCacheHits () const =0 |

Determine the rough number of cache hits since the cache statistics were last reset. | |

virtual int64_t | getCacheHitsMillis () const =0 |

Determine the total number of milliseconds (since that last statistics reset) for the get() operations for which an entry existed in this map. | |

virtual float64_t | getAverageHitMillis () const =0 |

Determine the average number of milliseconds per get() invocation that is a hit. | |

virtual int64_t | getCacheMisses () const =0 |

Determine the rough number of cache misses since the cache statistics were last reset. | |

virtual int64_t | getCacheMissesMillis () const =0 |

Determine the total number of milliseconds (since that last statistics reset) for the get() operations for which no entry existed in this map. | |

virtual float64_t | getAverageMissMillis () const =0 |

Determine the average number of milliseconds per get() invocation that is a miss. | |

virtual float64_t | getHitProbability () const =0 |

Determine the rough probability (0 <= p <= 1) that the next invocation will be a hit, based on the statistics collected since the last reset of the cache statistics. | |

virtual int64_t | getCachePrunes () const =0 |

Determine the rough number of cache pruning cycles since the cache statistics were last reset. | |

virtual int64_t | getCachePrunesMillis () const =0 |

Determine the total number of milliseconds (since that last statistics reset) spent on cache pruning. | |

virtual float64_t | getAveragePruneMillis () const =0 |

Determine the average number of milliseconds per cache pruning. | |

virtual void | resetHitStatistics ()=0 |

Reset the cache statistics. |

virtual int64_t getTotalGets | ( | ) | const` [pure virtual]` |

Determine the total number of get() operations since the cache statistics were last reset.

**Returns:**- the total number of get() operations

Implemented in SimpleCacheStatistics.

virtual int64_t getTotalGetsMillis | ( | ) | const` [pure virtual]` |

Determine the total number of milliseconds spent on get() operations since the cache statistics were last reset.

**Returns:**- the total number of milliseconds processing get() operations

Implemented in SimpleCacheStatistics.

virtual float64_t getAverageGetMillis | ( | ) | const` [pure virtual]` |

Determine the average number of milliseconds per get() invocation since the cache statistics were last reset.

**Returns:**- the average number of milliseconds per get() operation

Implemented in SimpleCacheStatistics.

virtual int64_t getTotalPuts | ( | ) | const` [pure virtual]` |

Determine the total number of put() operations since the cache statistics were last reset.

**Returns:**- the total number of put() operations

Implemented in SimpleCacheStatistics.

virtual int64_t getTotalPutsMillis | ( | ) | const` [pure virtual]` |

Determine the total number of milliseconds spent on put() operations since the cache statistics were last reset.

**Returns:**- the total number of milliseconds processing put() operations

Implemented in SimpleCacheStatistics.

virtual float64_t getAveragePutMillis | ( | ) | const` [pure virtual]` |

Determine the average number of milliseconds per put() invocation since the cache statistics were last reset.

**Returns:**- the average number of milliseconds per put() operation

Implemented in SimpleCacheStatistics.

virtual int64_t getCacheHits | ( | ) | const` [pure virtual]` |

Determine the rough number of cache hits since the cache statistics were last reset.

A cache hit is a read operation invocation (i.e. get()) for which an entry exists in this map.

**Returns:**- the number of get() calls that have been served by existing cache entries

Implemented in SimpleCacheStatistics.

virtual int64_t getCacheHitsMillis | ( | ) | const` [pure virtual]` |

Determine the total number of milliseconds (since that last statistics reset) for the get() operations for which an entry existed in this map.

**Returns:**- the total number of milliseconds for the get() operations that were hits

Implemented in SimpleCacheStatistics.

virtual float64_t getAverageHitMillis | ( | ) | const` [pure virtual]` |

Determine the average number of milliseconds per get() invocation that is a hit.

**Returns:**- the average number of milliseconds per cache hit

Implemented in SimpleCacheStatistics.

virtual int64_t getCacheMisses | ( | ) | const` [pure virtual]` |

Determine the rough number of cache misses since the cache statistics were last reset.

A cache miss is a get() invocation that does not have an entry in this map.

**Returns:**- the number of get() calls that failed to find an existing cache entry because the requested key was not in the cache

Implemented in SimpleCacheStatistics.

virtual int64_t getCacheMissesMillis | ( | ) | const` [pure virtual]` |

Determine the total number of milliseconds (since that last statistics reset) for the get() operations for which no entry existed in this map.

**Returns:**- the total number of milliseconds (since that last statistics reset) for the get() operations that were misses

Implemented in SimpleCacheStatistics.

virtual float64_t getAverageMissMillis | ( | ) | const` [pure virtual]` |

Determine the average number of milliseconds per get() invocation that is a miss.

**Returns:**- the average number of milliseconds per cache miss

Implemented in SimpleCacheStatistics.

virtual float64_t getHitProbability | ( | ) | const` [pure virtual]` |

Determine the rough probability (0 <= p <= 1) that the next invocation will be a hit, based on the statistics collected since the last reset of the cache statistics.

**Returns:**- the cache hit probability (0 <= p <= 1)

Implemented in SimpleCacheStatistics.

virtual int64_t getCachePrunes | ( | ) | const` [pure virtual]` |

Determine the rough number of cache pruning cycles since the cache statistics were last reset.

For the LocalCache implementation, this refers to the number of times that the `prune()`

method is executed.

**Returns:**- the total number of cache pruning cycles (since that last statistics reset)

Implemented in SimpleCacheStatistics.

virtual int64_t getCachePrunesMillis | ( | ) | const` [pure virtual]` |

Determine the total number of milliseconds (since that last statistics reset) spent on cache pruning.

For the LocalCache implementation, this refers to the time spent in the `prune()`

method.

**Returns:**- the total number of milliseconds (since that last statistics reset) for cache pruning operations

Implemented in SimpleCacheStatistics.

virtual float64_t getAveragePruneMillis | ( | ) | const` [pure virtual]` |

Determine the average number of milliseconds per cache pruning.

**Returns:**- the average number of milliseconds per cache pruning

Implemented in SimpleCacheStatistics.

The documentation for this class was generated from the following file:

- coherence/net/cache/CacheStatistics.hpp