mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-08 12:37:37 +00:00
121 lines
3.4 KiB
Plaintext
121 lines
3.4 KiB
Plaintext
/* 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/. */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
/**
|
|
* Information about networks that is exposed to network manager API consumers.
|
|
*/
|
|
[scriptable, uuid(e016d594-3072-11e1-9b7d-0010183a41af)]
|
|
interface nsINetworkInterface : nsISupports
|
|
{
|
|
const long NETWORK_STATE_UNKNOWN = -1;
|
|
const long NETWORK_STATE_CONNECTING = 0;
|
|
const long NETWORK_STATE_CONNECTED = 1;
|
|
const long NETWORK_STATE_SUSPENDED = 2;
|
|
const long NETWORK_STATE_DISCONNECTING = 3;
|
|
const long NETWORK_STATE_DISCONNECTED = 4;
|
|
|
|
/**
|
|
* Current network state, one of the NETWORK_STATE_* constants.
|
|
*
|
|
* When this changes, network interface implementations notify the
|
|
* 'network-interface-state-changed' observer notification.
|
|
*/
|
|
readonly attribute long state;
|
|
|
|
const long NETWORK_TYPE_WIFI = 0;
|
|
const long NETWORK_TYPE_MOBILE = 1;
|
|
const long NETWORK_TYPE_MOBILE_MMS = 2;
|
|
|
|
/**
|
|
* Network type. One of the NETWORK_TYPE_* constants.
|
|
*/
|
|
readonly attribute long type;
|
|
|
|
/**
|
|
* Name of the network interface. This identifier is unique.
|
|
*/
|
|
readonly attribute DOMString name;
|
|
|
|
/**
|
|
* Indicates whether DHCP should be run when the interface connects.
|
|
*/
|
|
readonly attribute boolean dhcp;
|
|
|
|
};
|
|
|
|
/**
|
|
* Manage network interfaces.
|
|
*/
|
|
[scriptable, uuid(3bc29392-2fba-11e1-80fd-0010183a41af)]
|
|
interface nsINetworkManager : nsISupports
|
|
{
|
|
/**
|
|
* Register the given network interface with the network manager.
|
|
*
|
|
* Consumers will be notified with the 'network-interface-registered'
|
|
* observer notification.
|
|
*
|
|
* Throws if there's already an interface registered that has the same
|
|
* name.
|
|
*
|
|
* @param network
|
|
* Network interface to register.
|
|
*/
|
|
void registerNetworkInterface(in nsINetworkInterface network);
|
|
|
|
/**
|
|
* Unregister the given network interface from the network manager.
|
|
*
|
|
* Consumers will be notified with the 'network-interface-unregistered'
|
|
* observer notification.
|
|
*
|
|
* Throws an exception if the specified network interface object isn't
|
|
* registered.
|
|
*
|
|
* @param network
|
|
* Network interface to unregister.
|
|
*/
|
|
void unregisterNetworkInterface(in nsINetworkInterface network);
|
|
|
|
/**
|
|
* Object containing all known network connections, keyed by their
|
|
* interface name.
|
|
*/
|
|
readonly attribute jsval networkInterfaces;
|
|
|
|
/**
|
|
* The preferred network type. One of the
|
|
* nsINetworkInterface::NETWORK_TYPE_* constants.
|
|
*
|
|
* This attribute is used for setting default route to favor
|
|
* interfaces with given type. This can be overriden by calling
|
|
* overrideDefaultRoute().
|
|
*/
|
|
attribute long preferredNetworkType;
|
|
|
|
/**
|
|
* The network interface handling all data traffic.
|
|
*
|
|
* When this changes, the 'network-active-changed' observer
|
|
* notification is dispatched.
|
|
*/
|
|
readonly attribute nsINetworkInterface active;
|
|
|
|
/**
|
|
* Override the default behaviour for preferredNetworkType and route
|
|
* all network traffic through the the specified interface.
|
|
*
|
|
* Consumers can observe changes to the active network by subscribing to
|
|
* the 'network-active-changed' observer notification.
|
|
*
|
|
* @param network
|
|
* Network to route all network traffic to. If this is null,
|
|
* a previous override is canceled.
|
|
*/
|
|
long overrideActive(in nsINetworkInterface network);
|
|
|
|
};
|