sbIMetrics Interface Reference

Metrics service interface This is an interface to the songbird metrics service, used to phone home and send metrics gathered since the last report was sent. More...

List of all members.

Public Member Functions

void checkUploadMetrics ()
 Perform anonymous metrics upload if needed. This method checks how much time has elapsed since the last time metrics were uploaded. If enough time has elapsed, metrics data is extracted from the user's dataremote repository and sent to the metrics server. The metrics repository is then emptied and a new metrics gathering session begins. This function may return without performing any task if the user has disabled metrics gathering.
boolean getSessionFlag ()
 Returns the session flag. The session flag is set when the application starts up, and cleared when it terminates. This allows a simple detection of crashes if this function returns true before. setSessionFlag(true) has been called.
void setSessionFlag (in boolean flag)
 Sets the session flag. The session flag is set when the application starts up, and cleared when it terminates. This allows a simple detection of crashes if getSessionFlag returns true before this function has been called with a value of 'true'.


Detailed Description

Metrics service interface This is an interface to the songbird metrics service, used to phone home and send metrics gathered since the last report was sent.

Definition at line 44 of file sbIMetrics.idl.


Member Function Documentation

void sbIMetrics::setSessionFlag ( in boolean  flag  ) 

Sets the session flag. The session flag is set when the application starts up, and cleared when it terminates. This allows a simple detection of crashes if getSessionFlag returns true before this function has been called with a value of 'true'.

Parameters:
flag the value of the session flag (boolean)


The documentation for this interface was generated from the following file:
Generated on Mon Aug 21 21:01:55 2006 for Songbird by  doxygen 1.4.7