Merge pull request pwittchen#121 from pwittchen/issue-119

Piotr Wittchen · web-flow · commit aadb015f67e3 · 2016-07-18T21:33:33.000+02:00
adding ping customization
diff --git a/README.md b/README.md
@@ -28,6 +28,7 @@ Contents
         - [Custom logger](#custom-logger)
         - [Enabling WiFi scan](#enabling-wifi-scan)
         - [Enabling Internet connection check](#enabling-internet-connection-check)
+        - [Customizing ping parameters](#customizing-ping-parameters)
     - [Register and unregister objects](#register-and-unregister-objects)
     - [Subscribe for the events](#subscribe-for-the-events)
     - [NetworkHelper](#networkhelper)
@@ -156,6 +157,17 @@ networkEvents = new NetworkEvents(context, busWrapper)
   .enableInternetCheck();
 ```
 
+##### customizing ping parameters
+
+You can customize ping parameters used to check Internet connectivity. You can set your own host, port and ping timeout in milliseconds as follows:
+
+```java
+networkEvents = new NetworkEvents(context, busWrapper)
+  .setPingParameters("www.anyhostyouwant.com", 80, 30)
+```
+
+In the example presented above, library will ping www.anyhostyouwant.com on port 80 with timeout equal to 30 milliseconds.
+
 ### Register and unregister objects
 
 We have to register and unregister objects in Activity Lifecycle.
diff --git a/network-events-library/src/main/java/com/github/pwittchen/networkevents/library/NetworkEvents.java b/network-events-library/src/main/java/com/github/pwittchen/networkevents/library/NetworkEvents.java
@@ -19,7 +19,7 @@
 import android.content.IntentFilter;
 import android.net.ConnectivityManager;
 import android.net.wifi.WifiManager;
-
+import com.github.pwittchen.networkevents.library.internet.OnlineChecker;
 import com.github.pwittchen.networkevents.library.internet.OnlineCheckerImpl;
 import com.github.pwittchen.networkevents.library.logger.Logger;
 import com.github.pwittchen.networkevents.library.logger.NetworkEventsLogger;
@@ -46,10 +46,11 @@ public final class NetworkEvents {
   private final NetworkConnectionChangeReceiver networkConnectionChangeReceiver;
   private final InternetConnectionChangeReceiver internetConnectionChangeReceiver;
   private final WifiSignalStrengthChangeReceiver wifiSignalStrengthChangeReceiver;
+  private final OnlineChecker onlineChecker;
 
   /**
-   * initializes NetworkEvents object
-   * with NetworkEventsLogger as default logger
+   * Initializes NetworkEvents object
+   * with NetworkEventsLogger as default logger.
    *
    * @param context Android context
    * @param busWrapper Wrapper for event bus
@@ -59,7 +60,7 @@ public NetworkEvents(Context context, BusWrapper busWrapper) {
   }
 
   /**
-   * initializes NetworkEvents object
+   * Initializes NetworkEvents object.
    *
    * @param context Android context
    * @param busWrapper Wrapper fo event bus
@@ -70,18 +71,18 @@ public NetworkEvents(Context context, BusWrapper busWrapper, Logger logger) {
     checkNotNull(busWrapper, "busWrapper == null");
     checkNotNull(logger, "logger == null");
     this.context = context;
+    this.onlineChecker = new OnlineCheckerImpl(context);
     this.networkConnectionChangeReceiver =
-        new NetworkConnectionChangeReceiver(busWrapper, logger, context,
-            new OnlineCheckerImpl(context));
+        new NetworkConnectionChangeReceiver(busWrapper, logger, context, onlineChecker);
     this.internetConnectionChangeReceiver =
         new InternetConnectionChangeReceiver(busWrapper, logger, context);
     this.wifiSignalStrengthChangeReceiver =
         new WifiSignalStrengthChangeReceiver(busWrapper, logger, context);
   }
 
   /**
-   * enables wifi access points scan
-   * when it's not called, WifiSignalStrengthChanged event will never occur
+   * Enables wifi access points scan.
+   * When it's not called, WifiSignalStrengthChanged event will never occur.
    *
    * @return NetworkEvents object
    */
@@ -91,7 +92,7 @@ public NetworkEvents enableWifiScan() {
   }
 
   /**
-   * enables internet connection check
+   * Enables internet connection check.
    * when it's not called, WIFI_CONNECTED_HAS_INTERNET
    * and WIFI_CONNECTED_HAS_NO_INTERNET ConnectivityStatus will never be set
    * Please, be careful! Internet connection check may contain bugs
@@ -105,9 +106,23 @@ public NetworkEvents enableInternetCheck() {
   }
 
   /**
-   * registers NetworkEvents
-   * should be executed in onCreate() method in activity
-   * or during creating instance of class extending Application
+   * Sets ping parameters of the host used to check Internet connection.
+   * If it's not set, library will use default ping parameters.
+   *
+   * @param host host to be pinged
+   * @param port port of the host
+   * @param timeoutInMs timeout in milliseconds
+   * @return NetworkEvents object
+   */
+  public NetworkEvents setPingParameters(String host, int port, int timeoutInMs) {
+    onlineChecker.setPingParameters(host, port, timeoutInMs);
+    return this;
+  }
+
+  /**
+   * Registers NetworkEvents.
+   * It should be executed in onCreate() method in activity
+   * or during creating instance of class extending Application.
    */
   public void register() {
     registerNetworkConnectionChangeReceiver();
@@ -123,9 +138,9 @@ public void register() {
   }
 
   /**
-   * unregisters NetworkEvents
-   * should be executed in onDestroy() method in activity
-   * or during destroying instance of class extending Application
+   * Unregisters NetworkEvents.
+   * It should be executed in onDestroy() method in activity
+   * or during destroying instance of class extending Application.
    */
   public void unregister() {
     context.unregisterReceiver(networkConnectionChangeReceiver);
diff --git a/network-events-library/src/main/java/com/github/pwittchen/networkevents/library/internet/OnlineChecker.java b/network-events-library/src/main/java/com/github/pwittchen/networkevents/library/internet/OnlineChecker.java
@@ -17,4 +17,6 @@
 
 public interface OnlineChecker {
   void check();
+
+  void setPingParameters(String host, int port, int timeoutInMs);
 }
diff --git a/network-events-library/src/main/java/com/github/pwittchen/networkevents/library/internet/OnlineCheckerImpl.java b/network-events-library/src/main/java/com/github/pwittchen/networkevents/library/internet/OnlineCheckerImpl.java
@@ -29,9 +29,9 @@ public final class OnlineCheckerImpl implements OnlineChecker {
   private static final int DEFAULT_PING_TIMEOUT_IN_MS = 2000;
 
   private final Context context;
-  private final String pingHost;
-  private final int pingPort;
-  private final int pingTimeout;
+  private String pingHost;
+  private int pingPort;
+  private int pingTimeout;
 
   public OnlineCheckerImpl(Context context) {
     this.context = context;
@@ -40,13 +40,6 @@ public OnlineCheckerImpl(Context context) {
     this.pingTimeout = DEFAULT_PING_TIMEOUT_IN_MS;
   }
 
-  public OnlineCheckerImpl(Context context, String pingHost, int pingPort, int pingTimeout) {
-    this.context = context;
-    this.pingHost = pingHost;
-    this.pingPort = pingPort;
-    this.pingTimeout = pingTimeout;
-  }
-
   @Override public void check() {
     new AsyncTask<Void, Void, Void>() {
       @Override protected Void doInBackground(Void... params) {
@@ -65,6 +58,12 @@ public OnlineCheckerImpl(Context context, String pingHost, int pingPort, int pin
     }.execute();
   }
 
+  @Override public void setPingParameters(String host, int port, int timeoutInMs) {
+    this.pingHost = host;
+    this.pingPort = port;
+    this.pingTimeout = timeoutInMs;
+  }
+
   private void sendBroadcast(boolean isOnline) {
     Intent intent = new Intent(InternetConnectionChangeReceiver.INTENT);
     intent.putExtra(InternetConnectionChangeReceiver.INTENT_EXTRA, isOnline);

Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,6 @@`
`17`	`17`
`18`	`18`	`public interface OnlineChecker {`
`19`	`19`	`void check();`
	`20`	`+`
	`21`	`+ void setPingParameters(String host, int port, int timeoutInMs);`
`20`	`22`	`}`