netwerk/base/public/nsINetworkLinkService.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* vim:expandtab:shiftwidth=4:tabstop=4:
   3  */
   4 /* ***** BEGIN LICENSE BLOCK *****
   5  * Version: NPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  *
   8  * The contents of this file are subject to the Mozilla Public
   9  * License Version 1.1 (the "License"); you may not use this file
  10  * except in compliance with the License. You may obtain a copy of
  11  * the License at http://www.mozilla.org/MPL/
  12  *
  13  * Software distributed under the License is distributed on an "AS
  14  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  15  * implied. See the License for the specific language governing
  16  * rights and limitations under the License.
  17  *
  18  * The Original Code is Novell code.
  19  *
  20  * The Initial Developer of the Original Code is Novell, Inc.
  21  *
  22  * Original Author: Robert O'Callahan (rocallahan@novell.com)
  23  *
  24  * Contributor(s):
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the NPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the NPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41
  42 /**
  43  * Network link status monitoring service.
  44  */
  45 [scriptable, uuid(61618a52-ea91-4277-a4ab-ebe10d7b9a64)]
  46 interface nsINetworkLinkService : nsISupports
  47 {
  48   /**
  49    * This is set to true when the system is believed to have a usable
  50    * network connection.
  51    *
  52    * The link is only up when network connections can be established. For
  53    * example, the link is down during DHCP configuration (unless there
  54    * is another usable interface already configured).
  55    *
  56    * If the link status is not currently known, we generally assume that
  57    * it is up.
  58    */
  59   readonly attribute boolean isLinkUp;
  60
  61   /**
  62    * This is set to true when we believe that isLinkUp is accurate.
  63    */
  64   readonly attribute boolean linkStatusKnown;
  65 };
  66
  67 %{C++
  68 /**
  69  * We send notifications through nsIObserverService with topic
  70  * NS_NETWORK_LINK_TOPIC whenever one of isLinkUp or linkStatusKnown
  71  * changes. We pass one of the NS_NETWORK_LINK_DATA_ constants below
  72  * as the aData parameter of the notification.
  73  */
  74 #define NS_NETWORK_LINK_TOPIC "network:link-status-changed"
  75
  76 /**
  77  * isLinkUp is now true, linkStatusKnown is true.
  78  */
  79 #define NS_NETWORK_LINK_DATA_UP      "up"
  80 /**
  81  * isLinkUp is now false, linkStatusKnown is true.
  82  */
  83 #define NS_NETWORK_LINK_DATA_DOWN    "down"
  84 /**
  85  * linkStatusKnown is now false.
  86  */
  87 #define NS_NETWORK_LINK_DATA_UNKNOWN "unknown"
  88 %}