WebAPI/ResourceStats: Difference between revisions

Jump to navigation Jump to search

WebAPI/ResourceStats (view source)

Revision as of 06:42, 10 February 2014

6,275 bytes added ,  10 February 2014
→‎ResourceStatsManager.webidl
No edit summary
Line 71: Line 71:


==== ResourceStatsManager.webidl ====
==== ResourceStatsManager.webidl ====
/**
  * Supported resource statistics
  */
enum ResourceType {
  "network",
  "power"
};
/**
  * List of system services supporting resource statistics
  */
enum SystemService {
  "ota",
  "tethering"
};
dictionary ResourceStatsOptions
{
  /**
    * |component| specifies which component's resource usage will be returned.
    * If null or undefined, sum of all components' usage is returned.
    *
    * |component| is expressed in "<component>:<id>", where <component> is the
    * name of the component and <id> is used to identify different entities.
    *
    * The <id> field is mainly used in specifying the identity of different SIMs
    * when quering mobile network usage, e.g. "mobile:<iccid>".
    *
    * Quering statistics of other components should specify the |component| to
    *  "<component>:0", such as "cpu:0" or "wifi:0".
    */
  DOMString? component = null;
  /**
    * |manifestURL| specifies the manifestURL of an application.
    * |systemService| specifies the system service.
    *
    * If both |systemService| and |manifestURL| are null or undefined, then a
    * system-wide resource statistics is returned.
    *
    * If |manifestURL| is specified, then the resource statistics of the
    * specified application is returned.
    *
    * If |systemService| is specified, then the resource statistics of the
    * specified system service is returned.
    *
    * If |systemService| and |manifestURL| are both specified, then the return
    * statistics indicates the resources that the system service consumed for
    * the application.
    */
  SystemService? serviceType = null;
  DOMString? manifestURL = null;
};
dictionary ResourceStatsAlarmOptions
{
  /**
    * |startTime| indicates the start time of counting the resource usage.
    *
    * |data| is used to reflect in the alarm object when the alarm is triggered.
    * |data| should be copied using the structured clone algorithm.
    */
  DOMTimeStamp      startTime;  // time in milliseconds since Epoch
  any              data;
};
[JSImplementation="@mozilla.org/resourceStatsAlarm;1", Pref="dom.resourceStats.enabled", AvailableIn="CertifiedApps"]
interface ResourceStatsAlarm
{
  readonly attribute unsigned long          alarmId;
  readonly attribute ResourceType          type;
  readonly attribute DOMString              component;
  readonly attribute SystemService          serviceType;
  readonly attribute DOMString              manifestURL;
  readonly attribute unsigned long long    threshold;
  readonly attribute any                    data;
};
[Constructor(ResourceType type), JSImplementation="@mozilla.org/resourceStatsManager;1", Pref="dom.resourceStats.enabled", AvailableIn="CertifiedApps"]
interface ResourceStatsManager
{
  /**
    * Query resource statistics.
    *
    * |statsOptions| specifies the detail of statistics of interest.
    *
    * |start| and |end| specifies the time range of interest, both included.
    * If |start| is null or undefined, retrieve the stats since measurements.
    * If |end| is null or undefined. retrieve the stats until the current time.
    *
    * If success, the fulfillment value is an array of ResourceStats object.
    */
  Promise getStats(optional ResourceStatsOptions statsOptions,
                    optional DOMTimeStamp? start = null,
                  optional DOMTimeStamp? end = null);
  /**
    * Clear resource statistics stored in database.
    *
    * |statsOptions| specifies the detail of statistics to delete.
    *
    * |start| and |end| specifies the time range of interest, both included.
    * If |start| is null or undefined, delete the stats since measurements.
    * If |end| is null or undefined. delete the stats until the current time.
    */
  Promise clearStats(optional ResourceStatsOptions statsOptions,
                      optional DOMTimeStamp? start = null,
                      optional DOMTimeStamp? end = null);
  /**
    * Clear all resource statistics stored in database.
    */
  Promise clearAllStats();
  /**
    * Install an alarm to monitor resource usage.
    *
    * The |threshold| is an object specified the limit of resource usage. When
    * resource usage reaches the threshold, a "resourceStats-alarm" system
    * message is sent to the application.
    *
    * |statsOptions| specifies the detail of statistics of interest.
    *
    * |alarmOptions| is a ResourceStatsAlarmOptions object.
    *
    * If success, the fulfillment value is an alarm ID.
    */
  Promise addAlarm(unsigned long long threshold,
                    optional ResourceStatsOptions statsOptions,
                    optional ResourceStatsAlarmOptions alarmOptions);
  /**
    * Obtain alarms.
    *
    * If |statsOptions| is provided, then only the alarms monitoring that
    * resource are returned. Otherwise, all alarms set for this resource type
    * is returned.
    *
    * If success, the fulfillment value is an array of ResourceStatsAlarm.
    */
  Promise getAlarms(optional ResourceStatsOptions statsOptions);
  /**
    * Remove the specified alarm.
    *
    * |alarmId| specifies the alarm to be removed.
    */
  Promise removeAlarm(unsigned long alarmId);
  /**
    * Remove all alarms.
    */
  Promise removeAllAlarms();
  /**
    * Enumerate components that have stored statistics in database.
    *
    * If success, the fulfillment value is an array of DOMString.
    */
  Promise getAvailableComponents();
  /**
    * Return supporting resource statistics, i.e. ["Network", "Power"]
    *
    * This should be specified as static attribute after Bug 863952 is resolved.
    */
  [Cached, Pure]
  readonly attribute sequence<DOMString> resourceTypes;
  /**
    * Time in milliseconds between statistics stored in database.
    *
    * This should be specified as static attribute after Bug 863952 is resolved.
    */
  readonly attribute unsigned long sampleRate;
  /**
    * Time in milliseconds recorded by the API until present time. All
    * statistics older than maxStorageAge from now are deleted.
    *
    * This should be specified as static attribute after Bug 863952 is resolved.
    */
  readonly attribute unsigned long long maxStorageAge;
};
Borting
Confirmed users
25

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/922388"

Navigation menu