summary refs log tree commit diff stats
path: root/org.fox.epube/src/main/java/org/fox/epube/NetworkStateReceiver.java
blob: 22afbe95673e4f0b27f56b779e1354719b9797e1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
package org.fox.epube;

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.net.ConnectivityManager;
import android.net.NetworkInfo;
import android.util.Log;

import java.util.ArrayList;
import java.util.List;

/**
 * NetworkStateReceiver defines a BroadcastReceiver which allows us to register for system (i.e. network status) or application events.
 * All registered receivers for an event are notified by the Android runtime once this event happens.
 * Source: http://stackoverflow.com/questions/6169059/android-event-for-internet-connectivity-state-change
 */
public class NetworkStateReceiver extends BroadcastReceiver {

    protected List<NetworkStateReceiverListener> listeners;
    protected Boolean connected;
    private String TAG = "NetworkStateReceiver";

    public NetworkStateReceiver() {
        listeners = new ArrayList<>();
        connected = null;
    }

    /**
     * Called when the BroadcastReceiver is receiving an Intent broadcast (event for which the broadcast receiver has registered occurs).
     * During this time you can use the other methods on BroadcastReceiver to view/modify the current result values.
     * NOTE: When it runs on the main thread you should never perform long-running operations in it (there is a timeout of 10 seconds that the system allows before considering the receiver to be blocked and a candidate to be killed).
     * NOTE: You cannot launch a popup dialog in your implementation of onReceive().
     *
     * @param context Object to access additional information or to start services or activities
     * @param intent  Object with action used to register your receiver. This object contains additional information (e.g. extras)
     */
    public void onReceive(Context context, Intent intent) {
        Log.i(TAG, "Intent broadcast received");
        if (intent == null || intent.getExtras() == null)
            return;

        // Retrieve a ConnectivityManager for handling management of network connections
        ConnectivityManager manager = (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
        // Details about the currently active default data network. When connected, this network is the default route for outgoing connections
        NetworkInfo networkInfo = manager.getActiveNetworkInfo();

        /**
         * NOTE: getActiveNetworkInfo() may return null when there is no default network e.g. Airplane Mode
         */
        if (networkInfo != null && networkInfo.getState() == NetworkInfo.State.CONNECTED) {
            connected = true;
        } else if (intent.getBooleanExtra(ConnectivityManager.EXTRA_NO_CONNECTIVITY, Boolean.FALSE)) {    //Boolean that indicates whether there is a complete lack of connectivity
            connected = false;
        }

        notifyStateToAll();
    }   //After the onReceive() of the receiver class has finished, the Android system is allowed to recycle the receiver

    /**
     * Notify the state to all needed methods
     */
    private void notifyStateToAll() {
        Log.i(TAG, "Notifying state to " + listeners.size() + " listener(s)");
        for (NetworkStateReceiverListener eachNetworkStateReceiverListener : listeners)
            notifyState(eachNetworkStateReceiverListener);
    }

    /**
     * Notify the network state, triggering interface functions based on the current state
     *
     * @param networkStateReceiverListener Object which implements the NetworkStateReceiverListener interface
     */
    private void notifyState(NetworkStateReceiverListener networkStateReceiverListener) {
        if (connected == null || networkStateReceiverListener == null)
            return;

        if (connected == true) {
            // Triggering function on the interface towards network availability
            networkStateReceiverListener.networkAvailable();
        } else {
            // Triggering function on the interface towards network being unavailable
            networkStateReceiverListener.networkUnavailable();
        }
    }

    /**
     * Adds a listener to the list so that it will receive connection state change updates
     *
     * @param networkStateReceiverListener Object which implements the NetworkStateReceiverListener interface
     */
    public void addListener(NetworkStateReceiverListener networkStateReceiverListener) {
        Log.i(TAG, "addListener() - listeners.add(networkStateReceiverListener) + notifyState(networkStateReceiverListener);");
        listeners.add(networkStateReceiverListener);
        notifyState(networkStateReceiverListener);
    }

    /**
     * Removes listener (when no longer necessary) from the list so that it will no longer receive connection state change updates
     *
     * @param networkStateReceiverListener Object which implements the NetworkStateReceiverListener interface
     */
    public void removeListener(NetworkStateReceiverListener networkStateReceiverListener) {
        listeners.remove(networkStateReceiverListener);
    }

    /**
     * Inner Interface (i.e. to encapsulate behavior in a generic and re-usable way) which handles connection state changes for classes which registered this receiver (Outer class NetworkStateReceiver)
     * This interface implements the 'Strategy Pattern', where an execution strategy is evaluated and applied internally at runtime
     */
    public interface NetworkStateReceiverListener {
        /**
         * When the connection state is changed and there is a connection, this method is called
         */
        void networkAvailable();

        /**
         * Connection state is changed and there is not a connection, this method is called
         */
        void networkUnavailable();
    }
}