Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIMetricsCollector Interface Reference

The nsIMetricsCollector interface is implemented by any object that collects data on behalf of the MetricsService. More...

import "nsIMetricsCollector.idl";

Inheritance diagram for nsIMetricsCollector:
Inheritance graph
[legend]
Collaboration diagram for nsIMetricsCollector:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void onAttach ()
 Notification that this collector should be enabled.
void onDetach ()
 Notification that this collector is no longer enabled.
void onNewLog ()
 Notification that the MetricsService is starting a new event log.

Detailed Description

The nsIMetricsCollector interface is implemented by any object that collects data on behalf of the MetricsService.

When the configuration file reequests collector "foo" in namespace "http://www.mozilla.org/metrics", the contract id "@mozilla.org/metrics/collector;1?name=http://www.mozilla.org/metrics:foo" is instantiated (using getSerivce). The collector is responsible for calling nsIMetricsService::logEvent() when it has something to log.

Definition at line 51 of file nsIMetricsCollector.idl.


Member Function Documentation

Notification that this collector should be enabled.

The collector should register itself for observer and event notifications as necessary.

Notification that this collector is no longer enabled.

The collector should unregister itself from observer and event notifications so that the object can be freed.

Notification that the MetricsService is starting a new event log.

This happens after any onDetach() notifications that result from parsing the new configuration.


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