зеркало из https://github.com/mozilla/gecko-dev.git
97 строки
3.1 KiB
Plaintext
97 строки
3.1 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*/
|
|
|
|
[NavigatorProperty="mozNetworkStats",
|
|
JSImplementation="@mozilla.org/networkStatsManager;1",
|
|
ChromeOnly,
|
|
Pref="dom.mozNetworkStats.enabled"]
|
|
interface MozNetworkStatsManager {
|
|
/**
|
|
* Constants for known interface types.
|
|
*/
|
|
const long WIFI = 0;
|
|
const long MOBILE = 1;
|
|
|
|
/**
|
|
* Find samples between two dates start and end, both included.
|
|
*
|
|
* If options is provided, per-app or per-system service usage will be
|
|
* retrieved; otherwise the target will be overall system usage.
|
|
*
|
|
* If success, the request result will be an MozNetworkStats object.
|
|
*/
|
|
DOMRequest getSamples(MozNetworkStatsInterface network,
|
|
Date start,
|
|
Date end,
|
|
optional NetworkStatsGetOptions options);
|
|
|
|
/**
|
|
* Install an alarm on a network. The network must be in the return of
|
|
* getAvailableNetworks() otherwise an "InvalidNetwork" exception will
|
|
* be raised.
|
|
*
|
|
* When total data usage reaches threshold bytes, a "networkstats-alarm"
|
|
* system message is sent to the application, where the optional parameter
|
|
* |data| must be a cloneable object.
|
|
*
|
|
* If success, the |result| field of the DOMRequest keeps the alarm Id.
|
|
*/
|
|
DOMRequest addAlarm(MozNetworkStatsInterface network,
|
|
long long threshold,
|
|
optional NetworkStatsAlarmOptions options);
|
|
|
|
/**
|
|
* Obtain all alarms for those networks returned by getAvailableNetworks().
|
|
* If a network is provided, only retrieves the alarms for that network.
|
|
* The network must be one of those returned by getAvailebleNetworks() or an
|
|
* "InvalidNetwork" exception will be raised.
|
|
*
|
|
* Each alarm object has the same fields as that in the system message:
|
|
* - alarmId
|
|
* - network
|
|
* - threshold
|
|
* - data
|
|
*/
|
|
DOMRequest getAllAlarms(optional MozNetworkStatsInterface network);
|
|
|
|
/**
|
|
* Remove all network alarms. If an |alarmId| is provided, then only that
|
|
* alarm is removed.
|
|
*/
|
|
DOMRequest removeAlarms(optional unsigned long alarmId = 0);
|
|
|
|
/**
|
|
* Remove all stats related with the provided network from DB.
|
|
*/
|
|
DOMRequest clearStats(MozNetworkStatsInterface network);
|
|
|
|
/**
|
|
* Remove all stats in the database.
|
|
*/
|
|
DOMRequest clearAllStats();
|
|
|
|
/**
|
|
* Return available networks that used to be saved in the database.
|
|
*/
|
|
DOMRequest getAvailableNetworks(); // array of MozNetworkStatsInterface.
|
|
|
|
/**
|
|
* Return available service types that used to be saved in the database.
|
|
*/
|
|
DOMRequest getAvailableServiceTypes(); // array of string.
|
|
|
|
/**
|
|
* Minimum time in milliseconds between samples stored in the database.
|
|
*/
|
|
readonly attribute long sampleRate;
|
|
|
|
/**
|
|
* Time in milliseconds recorded by the API until present time. All samples
|
|
* older than maxStorageAge from now are deleted.
|
|
*/
|
|
readonly attribute long long maxStorageAge;
|
|
};
|