Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.plugins
Class Timer

WEB-INF.cftags.component
        coldbox.system.FrameworkSupertype
            coldbox.system.Plugin
                coldbox.system.plugins.Timer

public class Timer
extends Plugin
extends Plugin

This is the Timer plugin. It is used to time executions. Facade for request variable

Constructor Summary
`init(any controller)` Constructor

Method Summary
`private void`	`addRow(string label, string tickcount)` Add a new timer row
`query`	`getTimerScope()` Returns the entire timer query from the request scope
`void`	`logTime(string Label, string Tickcount)` Use this method to add a new timer entry to the timers
`void`	`start(string Label)` Start the Timer with label
`void`	`stop(string Label)` Stop the timer with label

Methods inherited from class coldbox.system.Plugin
`getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL`

Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class coldbox.system.FrameworkSupertype

$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(any controller)

Constructor

Parameters:: controller

Method Detail

addRow

private void addRow(string label, string tickcount)

Add a new timer row.

getTimerScope

public query getTimerScope()

Returns the entire timer query from the request scope.

logTime

public void logTime(string Label, string Tickcount)

Use this method to add a new timer entry to the timers.

start

public void start(string Label)

Start the Timer with label.

stop

public void stop(string Label)

Stop the timer with label

Overview

Package