mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-31 22:25:30 +00:00
104 lines
3.2 KiB
Plaintext
104 lines
3.2 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* vim:expandtab:shiftwidth=4:tabstop=4:
|
|
*/
|
|
/* 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"
|
|
|
|
/**
|
|
* Network link status monitoring service.
|
|
*/
|
|
[scriptable, uuid(f7d3be87-7403-4a1e-b89f-2797776e9b08)]
|
|
interface nsINetworkLinkService : nsISupports
|
|
{
|
|
/* Link type constants */
|
|
const unsigned long LINK_TYPE_UNKNOWN = 0;
|
|
const unsigned long LINK_TYPE_ETHERNET = 1;
|
|
const unsigned long LINK_TYPE_USB = 2;
|
|
const unsigned long LINK_TYPE_WIFI = 3;
|
|
const unsigned long LINK_TYPE_WIMAX = 4;
|
|
const unsigned long LINK_TYPE_2G = 5;
|
|
const unsigned long LINK_TYPE_3G = 6;
|
|
const unsigned long LINK_TYPE_4G = 7;
|
|
|
|
/**
|
|
* This is set to true when the system is believed to have a usable
|
|
* network connection.
|
|
*
|
|
* The link is only up when network connections can be established. For
|
|
* example, the link is down during DHCP configuration (unless there
|
|
* is another usable interface already configured).
|
|
*
|
|
* If the link status is not currently known, we generally assume that
|
|
* it is up.
|
|
*/
|
|
readonly attribute boolean isLinkUp;
|
|
|
|
/**
|
|
* This is set to true when we believe that isLinkUp is accurate.
|
|
*/
|
|
readonly attribute boolean linkStatusKnown;
|
|
|
|
/**
|
|
* The type of network connection.
|
|
*/
|
|
readonly attribute unsigned long linkType;
|
|
};
|
|
|
|
%{C++
|
|
/**
|
|
* We send notifications through nsIObserverService with topic
|
|
* NS_NETWORK_LINK_TOPIC whenever one of isLinkUp or linkStatusKnown
|
|
* changes. We pass one of the NS_NETWORK_LINK_DATA_ constants below
|
|
* as the aData parameter of the notification.
|
|
*/
|
|
#define NS_NETWORK_LINK_TOPIC "network:link-status-changed"
|
|
|
|
/**
|
|
* isLinkUp is now true, linkStatusKnown is true.
|
|
*/
|
|
#define NS_NETWORK_LINK_DATA_UP "up"
|
|
/**
|
|
* isLinkUp is now false, linkStatusKnown is true.
|
|
*/
|
|
#define NS_NETWORK_LINK_DATA_DOWN "down"
|
|
/**
|
|
* linkStatusKnown is now false.
|
|
*/
|
|
#define NS_NETWORK_LINK_DATA_UNKNOWN "unknown"
|
|
|
|
/**
|
|
* We send notifications through nsIObserverService with topic
|
|
* NS_NETWORK_LINK_TYPE_TOPIC whenever the network connection type
|
|
* changes. We pass one of the valid connection type constants
|
|
* below as the aData parameter of the notification.
|
|
*/
|
|
#define NS_NETWORK_LINK_TYPE_TOPIC "network:link-type-changed"
|
|
|
|
/** We were unable to determine the network connection type */
|
|
#define NS_NETWORK_LINK_TYPE_UNKNOWN "unknown"
|
|
|
|
/** A standard wired ethernet connection */
|
|
#define NS_NETWORK_LINK_TYPE_ETHERNET "ethernet"
|
|
|
|
/** A connection via a USB port */
|
|
#define NS_NETWORK_LINK_TYPE_USB "usb"
|
|
|
|
/** A connection via a WiFi access point (IEEE802.11) */
|
|
#define NS_NETWORK_LINK_TYPE_WIFI "wifi"
|
|
|
|
/** A connection via WiMax (IEEE802.16) */
|
|
#define NS_NETWORK_LINK_TYPE_WIMAX "wimax"
|
|
|
|
/** A '2G' mobile connection (e.g. GSM, GPRS, EDGE) */
|
|
#define NS_NETWORK_LINK_TYPE_2G "2g"
|
|
|
|
/** A '3G' mobile connection (e.g. UMTS, CDMA) */
|
|
#define NS_NETWORK_LINK_TYPE_3G "3g"
|
|
|
|
/** A '4G' mobile connection (e.g. LTE, UMB) */
|
|
#define NS_NETWORK_LINK_TYPE_4G "4g"
|
|
%}
|