ReactiveNetwork is an Android library listening network connection state and Internet connectivity with RxJava Observables. It's a successor of Network Events library rewritten with Reactive Programming approach.
Library is compatible with RxJava 1.+ and RxAndroid 1.+ and uses them under the hood.
Library supports both new and legacy network monitoring strategies.
min sdk version = 9
JavaDoc is available at: http://pwittchen.github.io/ReactiveNetwork/
Important note❗: Since version 0.4.0, functionality releated to observing WiFi Access Points and WiFi singal strength (level) is removed in favor of ReactiveWiFi library. If you want to use this functionality, check ReactiveWiFi project.
If you want to see all changes in the public API, check release notes and JavaDoc.
Library has the following RxJava Observables available in the public API:
Observable<Connectivity> observeNetworkConnectivity(final Context context)
Observable<Connectivity> observeNetworkConnectivity(final Context context, final NetworkObservingStrategy strategy)
Observable<Boolean> observeInternetConnectivity()
Observable<Boolean> observeInternetConnectivity(final int interval, final String host, final int port, final int timeout)Please note: Due to memory leak in WifiManager reported
in issue 43945 in Android issue tracker
it's recommended to use Application Context instead of Activity Context.
We can observe Connectivity with observeNetworkConnectivity(context) method in the following way:
ReactiveNetwork.observeNetworkConnectivity(context)
.subscribeOn(Schedulers.io())
... // anything else what you can do with RxJava
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Action1<Connectivity>() {
@Override public void call(Connectivity connectivity) {
// do something with connectivity
// you can call connectivity.getState();
// connectivity.getType(); or connectivity.toString();
}
});When Connectivity changes, subscriber will be notified. Connectivity can change its state or type.
We can react on a concrete state, states, type or types changes with the filter(...) method from RxJava, hasState(final NetworkInfo.State... states) and hasType(final int... types) methods located in Connectivity class.
ReactiveNetwork.observeNetworkConnectivity(context)
.subscribeOn(Schedulers.io())
.filter(Connectivity.hasState(NetworkInfo.State.CONNECTED))
.filter(Connectivity.hasType(ConnectivityManager.TYPE_WIFI))
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Action1<Connectivity>() {
@Override public void call(Connectivity connectivity) {
// do something
}
});observeNetworkConnectivity(context) checks only connectivity with the network (not Internet) as it's based on BroadcastReceiver for API 20 and lower and uses NetworkCallback for API 21 and higher.
Concrete WiFi or mobile network may be connected to the Internet (and usually is), but it doesn't have to.
You can also use method:
Observable<Connectivity> observeNetworkConnectivity(final Context context, final NetworkObservingStrategy strategy)This method allows you to apply your own network observing strategy and is used by the library under the hood to determine appropriate strategy depending on the version of Android system.
Connectivity class is used by observeNetworkConnectivity(context) and observeNetworkConnectivity(context,networkObservingStrategy) methods. It has the following API:
// factory methods responsible for creating Connectivity object
Connectivity create()
Connectivity create(Context context)
Connectivity create(NetworkInfo.State state, int type, String name)
// methods returning information about connectivity
NetworkInfo.State getState()
int getType()
String getName()
boolean isDefault()
String toString()
// helper methods for filter(...) method from RxJava
Func1<Connectivity, Boolean> hasState(final NetworkInfo.State... states)
Func1<Connectivity, Boolean> hasType(final int... types)We can observe connectivity with the Internet in the following way:
ReactiveNetwork.observeInternetConnectivity()
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Action1<Boolean>() {
@Override public void call(Boolean isConnectedToInternet) {
// do something with isConnectedToInternet value
}
});An Observable will return true to the subscription if device is connected to the Internet and false if not.
Please note: This method is less efficient than observeNetworkConnectivity(context) method, because it opens socket connection with remote host (default is www.google.com) every two seconds with two seconds of timeout and consumes data transfer. Use this method if you really need it. Optionally, you can unsubscribe subcription right after you get notification that Internet is available and do the work you want in order to decrease network calls.
If you want to specify your own custom details for checking Internet connectivity, you can use the following method:
Observable<Boolean> observeInternetConnectivity(final int interval, final String host, final int port, final int timeout)It allows you to specify custom interval of checking connectivity in milliseconds, host, port and connection timeout in milliseconds.
Exemplary application is located in app directory of this repository.
If you want to know, how to use this library with Kotlin, check app-kotlin directory.
You can depend on the library through Maven:
<dependency>
<groupId>com.github.pwittchen</groupId>
<artifactId>reactivenetwork</artifactId>
<version>0.5.2</version>
</dependency>or through Gradle:
dependencies {
compile 'com.github.pwittchen:reactivenetwork:0.5.2'
}Tests are available in 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
Code style used in the project is called SquareAndroid from Java Code Styles repository by Square available at: https://github.com/square/java-code-styles.
Static code analysis runs Checkstyle, FindBugs, PMD and Lint. It can be executed with command:
./gradlew check
Reports from analysis are generated in library/build/reports/ directory.
- PAT Track - realtime Tracker for the public transit in Pittsburgh, PA
- eero - Home WiFi System
- ACN Android Framework
- and more...
Are you using this library in your app and want to be listed here? Send me a Pull Request or an e-mail to piotr@wittchen.biz.pl
Copyright 2016 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.