com.github.pwittchen.networkevents.library

Class NetworkEvents

java.lang.Object

com.github.pwittchen.networkevents.library.NetworkEvents

public final class NetworkEvents
extends java.lang.Object

NetworkEvents - Android library listening network events. It is able to detect ConnectivityStatus when it changes:

• 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.

Constructor Summary

Constructors

Constructor and Description
NetworkEvents(android.content.Context context, BusWrapper busWrapper) Initializes NetworkEvents object with NetworkEventsLogger as default logger.
NetworkEvents(android.content.Context context, BusWrapper busWrapper, Logger logger) Initializes NetworkEvents object.

Method Summary

Modifier and Type	Method and Description
NetworkEvents	enableInternetCheck() Enables internet connection check.
NetworkEvents	enableWifiScan() Enables wifi access points scan.
void	register() Registers NetworkEvents.
NetworkEvents	setPingParameters(java.lang.String host, int port, int timeoutInMs) Sets ping parameters of the host used to check Internet connection.
void	unregister() Unregisters NetworkEvents.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetworkEvents

public NetworkEvents(android.content.Context context,
                     BusWrapper busWrapper)

Initializes NetworkEvents object with NetworkEventsLogger as default logger.

Parameters:

context - Android context

busWrapper - Wrapper for event bus

NetworkEvents

public NetworkEvents(android.content.Context context,
                     BusWrapper busWrapper,
                     Logger logger)

Initializes NetworkEvents object.

Parameters:

context - Android context

busWrapper - Wrapper fo event bus

logger - message logger (NetworkEventsLogger logs messages to LogCat)

Method Detail

enableWifiScan

public NetworkEvents enableWifiScan()

Enables wifi access points scan. When it's not called, WifiSignalStrengthChanged event will never occur.

Returns:

NetworkEvents object

enableInternetCheck

public NetworkEvents enableInternetCheck()

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 that's why it's disabled by default.

Returns:

NetworkEvents object

setPingParameters

public NetworkEvents setPingParameters(java.lang.String host,
                                       int port,
                                       int timeoutInMs)

Sets ping parameters of the host used to check Internet connection. If it's not set, library will use default ping parameters.

Parameters:

host - host to be pinged

port - port of the host

timeoutInMs - timeout in milliseconds

Returns:

NetworkEvents object

register

public void register()

Registers NetworkEvents. It should be executed in onCreate() method in activity or during creating instance of class extending Application.

unregister

public void unregister()

Unregisters NetworkEvents. It should be executed in onDestroy() method in activity or during destroying instance of class extending Application.