An interface for running simple, time based, profiling. More...

Inheritance diagram for sbITimingService:

Collaboration diagram for sbITimingService:

Public Member Functions
void	startPerfTimer (in AString aTimerName)
	Start a performance timer. More...

long long	stopPerfTimer (in AString aTimerName)
	Stop a performance timer. More...

Public Attributes
attribute boolean	enabled
	Output the results of each timer to standard output when the service is shutdown. This is on by default. More...

attribute nsIFile	logFile
	Output the results to a log file. This is off by default. To enable, simple set this attribute to the log file you wish to use. More...

Detailed Description

An interface for running simple, time based, profiling.

Definition at line 42 of file sbITimingService.idl.

Member Function Documentation

void sbITimingService::startPerfTimer ( in AString aTimerName )

Start a performance timer.

Parameters

aTimerName A unique name for the performance timer.

Exceptions

NS_ERROR_ALREADY_INITIALIZED if a timer of the same name already exists.

long long sbITimingService::stopPerfTimer ( in AString aTimerName )

Stop a performance timer.

Parameters

aTimerName The unique name of the performance timer.

Exceptions

NS_ERROR_NOT_INITIALIZED if the timer was never initialized before being stopped or is already stopped.

attribute boolean sbITimingService::enabled

Output the results of each timer to standard output when the service is shutdown. This is on by default.

Definition at line 48 of file sbITimingService.idl.

attribute nsIFile sbITimingService::logFile

Output the results to a log file. This is off by default. To enable, simple set this attribute to the log file you wish to use.

Definition at line 55 of file sbITimingService.idl.

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

/home/martin/dev/nightingale-hacking/components/testharness/public/sbITimingService.idl