https://github.com/pwittchen/NetworkEvents
Android library listening network connection state and change of the WiFi signal strength with event bus
https://github.com/pwittchen/NetworkEvents
android event-bus greenrobot-bus internet-connection network-connection otto wifi
Last synced: 8 days ago
JSON representation
Android library listening network connection state and change of the WiFi signal strength with event bus
- Host: GitHub
- URL: https://github.com/pwittchen/NetworkEvents
- Owner: pwittchen
- License: apache-2.0
- Archived: true
- Created: 2014-08-05T22:44:07.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-02-25T23:24:38.000Z (about 8 years ago)
- Last Synced: 2024-08-02T13:24:59.627Z (9 months ago)
- Topics: android, event-bus, greenrobot-bus, internet-connection, network-connection, otto, wifi
- Language: Java
- Homepage:
- Size: 554 KB
- Stars: 450
- Watchers: 36
- Forks: 80
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-android-ui - https://github.com/pwittchen/NetworkEvents
- awesome-android-ui - https://github.com/pwittchen/NetworkEvents
README
NetworkEvents
===============================
[](https://travis-ci.org/pwittchen/NetworkEvents)
[](https://android-arsenal.com/details/1/1392)
[](https://maven-badges.herokuapp.com/maven-central/com.github.pwittchen/networkevents)
Android library listening network connection state and change of the WiFi signal strength with event bus.
It works with any implementation of the Event Bus. In this repository you can find samples with Otto and GreenRobot's bus.
min sdk version = 9
JavaDoc is available at: http://pwittchen.github.io/NetworkEvents
This project is deprecated!
---------------------------
This library is now **deprecated** and **no longer maintained** in favor of the following libraries, which do the same job, but in the better way:
- [**ReactiveNetwork**](https://github.com/pwittchen/ReactiveNetwork)
- [**ReactiveWiFi**](https://github.com/pwittchen/ReactiveWiFi)
Contents
--------
- [Overview](#overview)
- [Usage](#usage)
- [Initialize objects](#initialize-objects)
- [NetworkEvents customization](#networkevents-customization)
- [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)
- [Examples](#examples)
- [Download](#download)
- [Tests](#tests)
- [Code style](#code-style)
- [Who is using this library?](#who-is-using-this-library)
- [License](#license)
Overview
--------
Library is able to detect `ConnectivityStatus` when it changes.
```java
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, when we [enable WiFi scanning](#enabling-wifi-scan).
Library is able to detect `MobileNetworkType` when `ConnectivityStatus` changes to `MOBILE_CONNECTED`.
```java
public enum MobileNetworkType {
UNKNOWN("unknown"),
LTE("LTE"),
HSPAP("HSPAP"),
EDGE("EDGE"),
GPRS("GPRS");
...
}
```
Usage
-----
Appropriate permissions are already set in `AndroidManifest.xml` file for the library inside the `` tag.
They don't need to be set inside the specific application, which uses library.
### Initialize objects
In your activity add `BusWrapper` field, which wraps your Event Bus. You can use [Otto](http://square.github.io/otto/) as in this sample and then create `NetworkEvents` field.
```java
private BusWrapper busWrapper;
private NetworkEvents networkEvents;
```
Create implementation of `BusWrapper`. You can use any event bus here. E.g. [GreenRobot's Event Bus](https://github.com/greenrobot/EventBus). In this example, we are wrapping Otto Event bus.
```java
private BusWrapper getOttoBusWrapper(final Bus bus) {
return new BusWrapper() {
@Override public void register(Object object) {
bus.register(object);
}
@Override public void unregister(Object object) {
bus.unregister(object);
}
@Override public void post(Object event) {
bus.post(event);
}
};
}
```
Initialize objects in `onCreate(Bundle savedInstanceState)` method.
```java
@Override protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
busWrapper = getOttoBusWrapper(new Bus());
networkEvents = new NetworkEvents(context, busWrapper);
}
```
**Please note**: Due to memory leak in `WifiManager` reported
in [issue 43945](https://code.google.com/p/android/issues/detail?id=43945) in Android issue tracker
it's recommended to use Application Context instead of Activity Context.
#### NetworkEvents Customization
##### Custom logger
By default library logs messages about changed connectivity or WiFi signal strength to LogCat.
We can create custom logger implementation in the following way:
```java
networkEvents = new NetworkEvents(context, busWrapper, new Logger() {
@Override public void log(String message) {
// log your message here
}
});
```
If we don't want to log anything, we can simply create empty implementation of the `Logger` interface, when `log(message)` method doesn't do anything.
##### enabling WiFi scan
WiFi Access Points scanning is disabled by default. If Wifi Access Points Scan is not enabled, `WifiSignalStrengthChanged` event will never occur. You can enable it as follows:
```java
networkEvents = new NetworkEvents(context, busWrapper)
.enableWifiScan();
```
##### enabling Internet connection check
Internet connection check is disabled by default. If Internet check is disabled, status `WIFI_CONNECTED_HAS_INTERNET` and `WIFI_CONNECTED_HAS_NO_INTERNET` won't be set.
If internet check is enabled `WIFI_CONNECTED` status will never occur (from version 2.1.0). The only statuses, which may occur after connecting to WiFi after enabling this option are `WIFI_CONNECTED_HAS_INTERNET` and `WIFI_CONNECTED_HAS_NO_INTERNET`.
You can enable internet check as follows:
```java
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.
In case of different Event Buses, we have to do it differently.
#### Otto Bus
Register `BusWrapper` and `NetworkEvents` in `onResume()` method and unregister them in `onPause()` method.
```java
@Override protected void onResume() {
super.onResume();
busWrapper.register(this);
networkEvents.register();
}
@Override protected void onPause() {
super.onPause();
busWrapper.unregister(this);
networkEvents.unregister();
}
```
#### GreenRobot's Bus
Register `BusWrapper` and `NetworkEvents` in `onStart()` method and unregister them in `onStop()` method.
```java
@Override protected void onStart() {
super.onStart();
busWrapper.register(this);
networkEvents.register();
}
@Override protected void onStop() {
busWrapper.unregister(this);
networkEvents.unregister();
super.onStop();
}
```
### Subscribe for the events
For Otto Event Bus `@Subscribe` annotations are required, but we don't have to use them in case of using library with GreenRobot's Event Bus.
```java
@Subscribe public void onEvent(ConnectivityChanged event) {
// get connectivity status from event.getConnectivityStatus()
// or mobile network type via event.getMobileNetworkType()
// and do whatever you want
}
@Subscribe public void onEvent(WifiSignalStrengthChanged event) {
// do whatever you want - e.g. read fresh list of access points
// via event.getWifiScanResults() method
}
```
### NetworkHelper
Library has additional class called `NetworkHelper` with static method, which can be used for determining if device is connected to WiFi or mobile network:
```java
NetworkHelper.isConnectedToWiFiOrMobileNetwork(context)
```
It returns `true` if device is connected to one of mentioned networks and `false` if not.
Examples
--------
* Look at `MainActivity` in application located in `example` directory to see how this library works with Otto Event Bus.
* Example presenting how to use this library with GreenRobot's Event Bus is presented in `example-greenrobot-bus ` directory
Download
--------
You can depend on the library through Maven:
```xml
com.github.pwittchen
networkevents
2.1.6
```
or through Gradle:
```groovy
dependencies {
compile 'com.github.pwittchen:networkevents:2.1.6'
}
```
**Remember to add dependency to the Event Bus, which you are using.**
In case of Otto, add the following dependency through Maven:
```xml
com.squareup
otto
1.3.8
```
or through Gradle:
```groovy
dependencies {
compile 'com.squareup:otto:1.3.8'
}
```
You can also use **GreenRobot's Event Bus** or **any Event Bus you want**.
Tests
-----
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.
Code style
----------
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.
Who is using this library?
--------------------------
- [Ceerus - app providing secure voice, video and messaging with technology developed through research with the UK Ministry of Defence](https://play.google.com/store/apps/details?id=com.sqrsystems.anchor)
- [FP Mobile](https://play.google.com/store/apps/details?id=com.fp.fpmobile)
- [BetterX-Android](https://github.com/eliasall/BetterX-Android)
Are you using this library in your app and want to be listed here? Send me a Pull Request or an e-mail to [email protected]
License
-------
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.