gov/nasa/worldwind/util/NetworkStatus.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government
   3 as represented by the Administrator of the
   4 National Aeronautics and Space Administration.
   5 All Rights Reserved.
   6 */
   7 package gov.nasa.worldwind.util;
   8
   9 import gov.nasa.worldwind.avlist.AVList;
  10
  11 import java.net.URL;
  12
  13 /**
  14  * @author tag
  15  * @version $Id: NetworkStatus.java 3735 2007-12-06 02:20:43Z tgaskins $
  16  */
  17 public interface NetworkStatus extends AVList
  18 {
  19     void logUnavailableHost(URL url);
  20
  21     void logAvailableHost(URL url);
  22
  23     boolean isHostUnavailable(URL url);
  24
  25     boolean isNetworkUnavailable();
  26
  27     boolean isWorlWindServerUnavailable();
  28
  29     int getAttemptLimit();
  30
  31     long getTryAgainInterval();
  32
  33     /**
  34      * Indicates whether World Wind will attempt to connect to the network to retrieve data or for other reasons.
  35      *
  36      * @return <code>true</code> if World Wind is in off-line mode, <code>false</code> if not.
  37      */
  38     boolean isOfflineMode();
  39
  40     /**
  41      * Indicate whether World Wind should attempt to connect to the network to retrieve data or for other reasons.
  42      * The default value for this attribute is <code>false</code>, indicating that the network should be used.
  43      *
  44      * @param offlineMode <code>true</code> if World Wind should use the network, <code>false</code> otherwise
  45      */
  46     void setOfflineMode(boolean offlineMode);
  47
  48     /**
  49      * Set the number of times a host must be logged as unavailable before it is marked unavailable in this class.
  50      *
  51      * @param limit the number of log-unavailability invocations necessary to consider the host unreachable.
  52      * @throws IllegalArgumentException if the limit is less than 1.
  53      */
  54     void setAttemptLimit(int limit);
  55
  56     /**
  57      * Set the length of time to wait until a host is marked as not unreachable subsequent to its being marked
  58      * unreachable.
  59      *
  60      * @param interval The length of time, in milliseconds, to wait to unmark a host as unreachable.
  61      * @throws IllegalArgumentException if the interval is less than 0.
  62      */
  63     void setTryAgainInterval(long interval);
  64 }