Pokemon expiry timer implemented: HandlerThread with messages posted on it for next expiring pokemon. (#214)

Author: rohanjain1

app/src/main/java/com/omkarmoghe/pokemap/controllers/MarkerRefreshController.java

@@ -0,0 +1,107 @@
+package com.omkarmoghe.pokemap.controllers;
+
+import android.os.Handler;
+import android.os.HandlerThread;
+import android.support.design.widget.TabLayout;
+import android.util.Log;
+
+import com.omkarmoghe.pokemap.models.events.MarkerUpdateEvent;
+
+import org.greenrobot.eventbus.EventBus;
+
+/**
+ * Created by Rohan on 26-07-2016.
+ */
+
+
+public class MarkerRefreshController {
+
+    final private String TAG = MarkerRefreshController.class.getName();
+
+    private HandlerThread mThread;
+    private Handler mHandler;
+    private static final int DEFAULT_UPDATE_INTERVAL = 10 * 1000;//10 seconds : heartbeat
+    private long updateInterval = DEFAULT_UPDATE_INTERVAL;
+    private MarkerUpdateEvent mEvent;
+    private Runnable markerExpiryUpdate;
+
+    private static MarkerRefreshController mInstance;
+
+    private MarkerRefreshController() {
+        if (mThread == null) {
+
+            mThread = new HandlerThread("MarkerRefreshThread");
+            mThread.start();
+            mHandler = new Handler(mThread.getLooper());
+            mEvent = new MarkerUpdateEvent();
+            markerExpiryUpdate = new Runnable() {
+                @Override
+                public void run()
+                {
+                    /**
+                     * Talking to:
+                     * {@link com.omkarmoghe.pokemap.views.map.MapWrapperFragment,}
+                     */
+                    EventBus.getDefault().post(new MarkerUpdateEvent());
+                }
+            };
+
+        } else {
+            throw new RuntimeException("Invalid state of Marker Refresh Thread.");
+        }
+
+    }
+
+    /*
+     * Singleton getter
+     */
+    public static MarkerRefreshController getInstance() {
+        if (mInstance == null) {
+            mInstance = new MarkerRefreshController();
+        }
+        return mInstance;
+    }
+
+
+    /**
+     * Cleanup thread state.
+     * Must ensure thread is properly quitting to allow safe reInit when needed
+     */
+    public void clear() {
+        if(mThread!=null) {
+            try {
+                mThread.join();
+                mThread.quit();            //I don't need to process the scheduled messages in queue.
+
+            } catch (InterruptedException e) {
+                Log.d(TAG, "Quitting too soon.. doing final cleanup");
+            } finally {
+                mThread = null;
+                mInstance = null;
+            }
+        }
+    }
+
+    /**
+     * Combo call for starting, resetting, refreshing, scheduling next update
+     * Must be called separately after [@link notifyTimeToExpiry]
+     */
+    public void reset() {
+        getInstance().mHandler.removeCallbacks(markerExpiryUpdate);
+        getInstance().mHandler.postDelayed(markerExpiryUpdate, updateInterval);
+        updateInterval = DEFAULT_UPDATE_INTERVAL;
+    }
+
+    /**
+     * Hook to determine next closest expiration time.
+     * Can be scheduled at regular intervals to use as a heartbeat.
+     *
+     * @param timeToExpiry
+     */
+    public void notifyTimeToExpiry(long timeToExpiry) {
+        if (updateInterval > timeToExpiry) {
+            updateInterval = timeToExpiry;
+        }
+    }
+
+}

app/src/main/java/com/omkarmoghe/pokemap/models/events/MarkerUpdateEvent.java

@@ -0,0 +1,12 @@
+package com.omkarmoghe.pokemap.models.events;
+
+/**
+ * Created by Rohan on 26-07-2016.
+ */
+
+/**
+ * Empty event.
+ */
+public class MarkerUpdateEvent {
+    //int _Data = 404;
+}

app/src/main/java/com/omkarmoghe/pokemap/views/MainActivity.java

@@ -14,6 +14,7 @@
 import android.view.MenuItem;
 import com.google.android.gms.maps.model.LatLng;
 import com.omkarmoghe.pokemap.R;
+import com.omkarmoghe.pokemap.controllers.MarkerRefreshController;
 import com.omkarmoghe.pokemap.controllers.service.PokemonNotificationService;
 import com.omkarmoghe.pokemap.models.events.ClearMapEvent;
 import com.omkarmoghe.pokemap.models.events.InternalExceptionEvent;

app/src/main/java/com/omkarmoghe/pokemap/views/map/MapWrapperFragment.java

@@ -31,13 +31,15 @@
 import com.google.android.gms.maps.model.Marker;
 import com.google.android.gms.maps.model.MarkerOptions;
 import com.omkarmoghe.pokemap.R;
+import com.omkarmoghe.pokemap.controllers.MarkerRefreshController;
 import com.omkarmoghe.pokemap.controllers.app_preferences.PokemapAppPreferences;
 import com.omkarmoghe.pokemap.controllers.app_preferences.PokemapSharedPreferences;
 import com.omkarmoghe.pokemap.controllers.map.LocationManager;
 import com.omkarmoghe.pokemap.helpers.RemoteImageLoader;
 import com.omkarmoghe.pokemap.models.events.CatchablePokemonEvent;
 import com.omkarmoghe.pokemap.models.events.ClearMapEvent;
 import com.omkarmoghe.pokemap.models.events.GymsEvent;
+import com.omkarmoghe.pokemap.models.events.MarkerUpdateEvent;
 import com.omkarmoghe.pokemap.models.events.PokestopsEvent;
 import com.omkarmoghe.pokemap.models.events.SearchInPosition;
 import com.omkarmoghe.pokemap.models.map.GymMarkerExtended;
@@ -352,6 +354,7 @@ public void onFetch(Bitmap  bitmap) {
                 userSelectedPositionCircles.clear();
             }
         }
+        MarkerRefreshController.getInstance().reset();
     }
 
     private float getDistanceInMeters(double lat1, double lon1, double lat2, double lon2) {
@@ -527,6 +530,33 @@ public void onFetch(Bitmap bitmap) {
         }
     }
 
+    private void removeExpiredMarkers() {
+
+                if (mGoogleMap != null) {
+                    if (markerList != null && !markerList.isEmpty()) {
+                        for (Iterator<Map.Entry<String, PokemonMarkerExtended>> pokemonIterator = markerList.entrySet().iterator(); pokemonIterator.hasNext(); ) {
+                            Map.Entry<String, PokemonMarkerExtended> pokemonEntry = pokemonIterator.next();
+                            CatchablePokemon catchablePokemon = pokemonEntry.getValue().getCatchablePokemon();
+                            Marker marker = pokemonEntry.getValue().getMarker();
+
+                                long millisLeft = catchablePokemon.getExpirationTimestampMs() - System.currentTimeMillis();
+                                if (millisLeft < 0) {
+                                    marker.remove();
+                                    pokemonIterator.remove();
+                                } else {
+                                    marker.setSnippet(getExpirationBreakdown(millisLeft));
+                                    if (marker.isInfoWindowShown()) {
+                                        marker.showInfoWindow();
+                                    }
+                                    MarkerRefreshController.getInstance().notifyTimeToExpiry(millisLeft);}
+                        }
+                        MarkerRefreshController.getInstance().reset();
+                    }
+                }
+
+    }
+
+
     private void showMapNotInitializedError() {
         if(getView() != null){
             Snackbar.make(getView(), getString(R.string.toast_map_not_initialized), Snackbar.LENGTH_SHORT).show();
@@ -593,6 +623,19 @@ public void onEvent(GymsEvent event) {
         setGymsMarkers(event);
     }
 
+    /**
+     * Called whenever a MarkerUpdateEvent is posted to the bus. Posted by {@link MarkerRefreshController} when
+     * expired markers need to be removed.
+     *
+     * @param event
+     */
+
+     @Subscribe(threadMode = ThreadMode.MAIN)
+     public void onEvent(MarkerUpdateEvent event){
+         removeExpiredMarkers();
+     }
+
+
     private void clearCatchedPokemonCircle() {
 
         //Check and eventually remove old marker