coldbox.system.cache.providers.lucee-lib

Class LuceeStats

lucee.Component
    extended by coldbox.system.cache.providers.lucee-lib.LuceeStats
All Implemented Interfaces:
IStats

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Author: Luis Majano Description: A coldfusion statistics object that communicates with the lucee cache stats

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    any cacheProvider


    • access = public
    • returntype = any
    		 false false
    Constructor Summary
    init(any<ICacheProvider> cacheProvider)
          Constructor.
    Method Summary
    any clearStatistics()
         Clear the stats.
    numeric getCachePerformanceRatio()
         Get the cache's performance ratio.
    string getCacheProvider()
    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.
    any setCacheProvider(any cacheProvider)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any<ICacheProvider> cacheProvider)

    Constructor

    Parameters:
    cacheProvider - The associated cache manager/provider of type: coldbox.system.cache.providers.ICacheProvider
    Property Detail

    cacheProvider

    property any cacheProvider

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - false
    Method Detail

    clearStatistics

    public any clearStatistics()

    Clear the stats

    Specified by:
    clearStatistics in interface IStats
    Returns:
    IStats

    getCachePerformanceRatio

    public numeric getCachePerformanceRatio()

    Get the cache's performance ratio

    Specified by:
    getCachePerformanceRatio in interface IStats

    getCacheProvider

    public string getCacheProvider()

    getEvictionCount

    public numeric getEvictionCount()

    Get the total cache's eviction count

    Specified by:
    getEvictionCount in interface IStats

    getGarbageCollections

    public numeric getGarbageCollections()

    Get the total cache's garbage collections

    Specified by:
    getGarbageCollections in interface IStats

    getHits

    public numeric getHits()

    Get the total cache's hits

    Specified by:
    getHits in interface IStats

    getLastReapDatetime

    public any getLastReapDatetime()

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

    Specified by:
    getLastReapDatetime in interface IStats
    Returns:
    date/time or empty

    getMisses

    public numeric getMisses()

    Get the total cache's misses

    Specified by:
    getMisses in interface IStats

    getObjectCount

    public numeric getObjectCount()

    Get the associated cache's live object count

    Specified by:
    getObjectCount in interface IStats

    setCacheProvider

    public any setCacheProvider(any cacheProvider)

    Parameters:
    cacheProvider