coldbox.system.cache.util

Interface IStats

coldbox.system.cache.util.IStats
All Known Implementing Classes:
CFStats , LuceeStats , CacheStats

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- The main interface for a CacheBox cache provider statistics object

Class Attributes:
  • author : Luis Majano
    •  
    Method Summary
    any clearStatistics()
         Clear the stats.
    numeric getCachePerformanceRatio()
         Get the cache's performance ratio.
    numeric getEvictionCount()
         Get the total cache's eviction count.
    numeric getGarbageCollections()
         Get the total cache's garbage collections.
    numeric getHits()
         Get the total cache's hits.
    any getLastReapDatetime()
         Get the date/time of the last reap the cache did.
    numeric getMisses()
         Get the total cache's misses.
    numeric getObjectCount()
         Get the associated cache's live object count.
    Method Detail

    clearStatistics

    public any clearStatistics()

    Clear the stats

    Returns:
    IStats

    getCachePerformanceRatio

    public numeric getCachePerformanceRatio()

    Get the cache's performance ratio

    getEvictionCount

    public numeric getEvictionCount()

    Get the total cache's eviction count

    getGarbageCollections

    public numeric getGarbageCollections()

    Get the total cache's garbage collections

    getHits

    public numeric getHits()

    Get the total cache's hits

    getLastReapDatetime

    public any getLastReapDatetime()

    Get the date/time of the last reap the cache did

    Returns:
    date/time or empty

    getMisses

    public numeric getMisses()

    Get the total cache's misses

    getObjectCount

    public numeric getObjectCount()

    Get the associated cache's live object count