com.github.pwittchen.reactivenetwork.library

Class ReactiveNetwork

java.lang.Object

com.github.pwittchen.reactivenetwork.library.ReactiveNetwork

public class ReactiveNetwork
extends java.lang.Object

ReactiveNetwork is an Android library listening network connection state and change of the WiFi signal strength with RxJava Observables. It can be easily used with RxAndroid.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOG_TAG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReactiveNetwork()

Method Summary

Modifier and Type	Method and Description
static ReactiveNetwork	create() Creates a new instance of the ReactiveNetwork class
static <any>	observeInternetConnectivity() Observes connectivity with the Internet with default settings.
static <any>	observeInternetConnectivity(InternetObservingStrategy strategy) Observes connectivity with the Internet with default settings, but with custom InternetObservingStrategy.
static <any>	observeInternetConnectivity(InternetObservingStrategy strategy, int initialIntervalInMs, int intervalInMs, java.lang.String host, int port, int timeoutInMs, ErrorHandler errorHandler) Observes connectivity with the Internet
static <any>	observeInternetConnectivity(InternetObservingStrategy strategy, java.lang.String host) Observes connectivity with the Internet with default settings, but with custom InternetObservingStrategy and host.
static <any>	observeInternetConnectivity(int initialIntervalInMs, int intervalInMs, java.lang.String host, int port, int timeoutInMs) Observes connectivity with the Internet in a given time interval.
static <any>	observeInternetConnectivity(int initialIntervalInMs, int intervalInMs, java.lang.String host, int port, int timeoutInMs, ErrorHandler errorHandler) Observes connectivity with the Internet by opening connection with remote host in a given time interval.
static <any>	observeInternetConnectivity(int intervalInMs, java.lang.String host, int port, int timeoutInMs) Observes connectivity with the Internet in a given time interval.
static <any>	observeNetworkConnectivity(android.content.Context context) Observes network connectivity.
static <any>	observeNetworkConnectivity(android.content.Context context, NetworkObservingStrategy strategy) Observes network connectivity.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

public static final java.lang.String LOG_TAG

See Also:

Constant Field Values

Constructor Detail

ReactiveNetwork

protected ReactiveNetwork()

Method Detail

create

public static ReactiveNetwork create()

Creates a new instance of the ReactiveNetwork class

Returns:

ReactiveNetwork object

observeNetworkConnectivity

public static <any> observeNetworkConnectivity(android.content.Context context)

Observes network connectivity. Information about network state, type and typeName are contained in observed Connectivity object.

Parameters:

context - Context of the activity or an application

Returns:

RxJava Observable with Connectivity class containing information about network state, type and typeName

observeNetworkConnectivity

public static <any> observeNetworkConnectivity(android.content.Context context,
                                               NetworkObservingStrategy strategy)

Observes network connectivity. Information about network state, type and typeName are contained in observed Connectivity object. Moreover, allows you to define NetworkObservingStrategy.

Parameters:

context - Context of the activity or an application

strategy - NetworkObserving strategy to be applied - you can use one of the existing strategies PreLollipopNetworkObservingStrategy, LollipopNetworkObservingStrategy or create your own custom strategy

Returns:

RxJava Observable with Connectivity class containing information about network state, type and typeName

observeInternetConnectivity

public static <any> observeInternetConnectivity()

Observes connectivity with the Internet with default settings. It pings remote host (clients3.google.com) at port 80 every 2 seconds with 2 seconds of timeout. This operation is used for determining if device is connected to the Internet or not. Please note that this method is less efficient than observeNetworkConnectivity(Context) method and consumes data transfer, but it gives you actual information if device is connected to the Internet or not.

Returns:

RxJava Observable with Boolean - true, when we have an access to the Internet and false if not

observeInternetConnectivity

public static <any> observeInternetConnectivity(InternetObservingStrategy strategy)

Observes connectivity with the Internet with default settings, but with custom InternetObservingStrategy. It pings remote host (clients3.google.com) at port 80 every 2 seconds with 2 seconds of timeout. This operation is used for determining if device is connected to the Internet or not. Please note that this method is less efficient than observeNetworkConnectivity(Context) method and consumes data transfer, but it gives you actual information if device is connected to the Internet or not.

Parameters:

strategy - which implements InternetObservingStrategy

Returns:

RxJava Observable with Boolean - true, when we have an access to the Internet and false if not

observeInternetConnectivity

public static <any> observeInternetConnectivity(InternetObservingStrategy strategy,
                                                java.lang.String host)

Observes connectivity with the Internet with default settings, but with custom InternetObservingStrategy and host. It pings remote host at port 80 every 2 seconds with 2 seconds of timeout. This operation is used for determining if device is connected to the Internet or not. Please note that this method is less efficient than observeNetworkConnectivity(Context) method and consumes data transfer, but it gives you actual information if device is connected to the Internet or not.

Parameters:

strategy - which implements InternetObservingStrategy

host - for checking Internet connectivity

Returns:

RxJava Observable with Boolean - true, when we have connection with host and false if not

observeInternetConnectivity

public static <any> observeInternetConnectivity(int intervalInMs,
                                                java.lang.String host,
                                                int port,
                                                int timeoutInMs)

Observes connectivity with the Internet in a given time interval.

Parameters:

intervalInMs - in milliseconds determining how often we want to check connectivity

host - for checking Internet connectivity

port - for checking Internet connectivity

timeoutInMs - for pinging remote host in milliseconds

Returns:

RxJava Observable with Boolean - true, when we have connection with host and false if not

observeInternetConnectivity

public static <any> observeInternetConnectivity(int initialIntervalInMs,
                                                int intervalInMs,
                                                java.lang.String host,
                                                int port,
                                                int timeoutInMs)

Observes connectivity with the Internet in a given time interval.

Parameters:

initialIntervalInMs - in milliseconds determining the delay of the first connectivity check

intervalInMs - in milliseconds determining how often we want to check connectivity

host - for checking Internet connectivity

port - for checking Internet connectivity

timeoutInMs - for pinging remote host in milliseconds

Returns:

RxJava Observable with Boolean - true, when we have connection with host and false if not

observeInternetConnectivity

public static <any> observeInternetConnectivity(int initialIntervalInMs,
                                                int intervalInMs,
                                                java.lang.String host,
                                                int port,
                                                int timeoutInMs,
                                                ErrorHandler errorHandler)

Observes connectivity with the Internet by opening connection with remote host in a given time interval.

Parameters:

initialIntervalInMs - in milliseconds determining the delay of the first connectivity check

intervalInMs - in milliseconds determining how often we want to check connectivity

host - for checking Internet connectivity

port - for checking Internet connectivity

timeoutInMs - for pinging remote host in milliseconds

errorHandler - for handling errors during connectivity check

Returns:

RxJava Observable with Boolean - true, when we have connection with host and false if not

observeInternetConnectivity

public static <any> observeInternetConnectivity(InternetObservingStrategy strategy,
                                                int initialIntervalInMs,
                                                int intervalInMs,
                                                java.lang.String host,
                                                int port,
                                                int timeoutInMs,
                                                ErrorHandler errorHandler)

Observes connectivity with the Internet

Parameters:

strategy - for observing Internet connectivity

initialIntervalInMs - in milliseconds determining the delay of the first connectivity check

intervalInMs - in milliseconds determining how often we want to check connectivity

host - for checking Internet connectivity

port - for checking Internet connectivity

timeoutInMs - for pinging remote host in milliseconds

errorHandler - for handling errors during connectivity check

Returns:

RxJava Observable with Boolean - true, when we have connection with host and false if not