netwerk/base/public/nsIIOService2.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 "nsIIOService.idl"
  41
  42 /**
  43  * nsIIOService2 extends nsIIOService with support for automatic
  44  * online/offline management.
  45  */
  46 [scriptable, uuid(d44fe6d4-ee35-4789-886a-eb8f0554d04e)]
  47 interface nsIIOService2 : nsIIOService
  48 {
  49   /**
  50    * While this is set, IOService will monitor an nsINetworkLinkService
  51    * (if available) and set its offline status to "true" whenever
  52    * isLinkUp is false.
  53    *
  54    * Applications that want to control changes to the IOService's offline
  55    * status should set this to false, watch for network:link-status-changed
  56    * broadcasts, and change nsIIOService::offline as they see fit. Note
  57    * that this means during application startup, IOService may be offline
  58    * if there is no link, until application code runs and can turn off
  59    * this management.
  60    */
  61   attribute boolean manageOfflineStatus;
  62 };