Songbird / Development / Songbird Add-Ons API Documentation

sbITimingService Interface Reference

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

import "sbITimingService.idl";

List of all members.

Public Member Functions

void startPerfTimer (in AString aTimerName)
 Start a performance timer.
long long stopPerfTimer (in AString aTimerName)
 Stop a performance timer.

Public Attributes

attribute boolean enabled
 Output the results of each timer to standard output when the service is shutdown. This is on by default.
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.


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.
Returns:
The delta between the start and the stop time in microseconds.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:29:02 2009 for Songbird by  doxygen 1.5.2