Android library listening network events.

min sdk version = 9

• Overview
• Usage
  • Set permissions
  • Initialize objects
  • Register and unregister objects
  • Subscribe for the events
• Examples
• Download
• Tests
• License

It is able to detect ConnectivityStatus when it changes.

public enum ConnectivityStatus {
    UNKNOWN("unknown"),
    WIFI_CONNECTED("connected to WiFi"),
    WIFI_CONNECTED_HAS_INTERNET("connected to WiFi (Internet available)"),
    WIFI_CONNECTED_HAS_NO_INTERNET("connected to WiFi (Internet not available)"),
    MOBILE_CONNECTED("connected to mobile network"),
    OFFLINE("offline");
    ...
}    

In addition, it is able to detect situation when strength of the Wifi signal was changed with WifiSignalStrengthChanged event.

Add permissions to AndroidManifest.xml file inside the <manifest> tag.

<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />

In your activity add Bus field from Otto Event Bus library and NetworkEvents field.

private Bus bus;
private NetworkEvents networkEvents;

Initialize objects in onCreate(Bundle savedInstanceState) method.

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    bus = new Bus();
    networkEvents = new NetworkEvents(this, bus);
}

You can customize NetworkEvents object. E.g. you can set your own ping url and ping timeout:

networkEvents = new NetworkEvents(this, bus)
        .withPingUrl("http://www.android.com")
        .withPingTimeout(50 * 1000);

You can also disable ping or Wifi Access Points Scan:

networkEvents = new NetworkEvents(this, bus)
        .withoutPing()
        .withoutWifiAccessPointsScan();

If you disable Wifi Access Points Scan, WifiSignalStrengthChanged event will never occur.

If you disable ping, status WIFI_CONNECTED_HAS_INTERNET and WIFI_CONNECTED_HAS_NO_INTERNET won't be set.

Register Bus and NetworkEvents in onResume() method and unregister them in onPause() method.

@Override
protected void onResume() {
    super.onResume();
    bus.register(this);
    networkEvents.register();
}

@Override
protected void onPause() {
    super.onPause();
    bus.unregister(this);
    networkEvents.unregister();
}

@Subscribe
public void onConnectivityChanged(ConnectivityChanged event) {
    // get connectivity status from event.getConnectivityStatus()
    // and do whatever you want
}

@Subscribe
public void onWifiSignalStrengthChanged(WifiSignalStrengthChanged event) {
    // do whatever you want - e.g. read fresh list of access points
}

• Look at MainActivity in application located in example directory to see how this library works.
• If you want to use this library with Dagger, check example-dagger directory.
• Example with disabling ping and Wifi Access Points Scan is available in example-disabling-ping-and-wifi-scan directory.
• Example with customizing pingUrl and pingTimeout is available in example-ping-customization directory.

You can depend on the library through Maven:

<dependency>
    <groupId>com.github.pwittchen</groupId>
    <artifactId>networkevents</artifactId>
    <version>1.0.5</version>
</dependency>

or through Gradle:

dependencies {
  compile 'com.github.pwittchen:networkevents:1.0.5'
}

Tests are available in network-events-library/src/androidTest/java/ directory and can be executed on emulator or Android device from Android Studio or CLI with the following command:

./gradlew connectedCheck

Test coverage report can be generated with the following command:

./gradlew createDebugCoverageReport

In order to generate report, emulator or Android device needs to be connected to the computer. Report will be generated in the network-events-library/build/outputs/reports/coverage/debug/ directory.

Copyright 2015 Piotr Wittchen

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.