Added queue back off logic

tonyofrancis · tonyofrancis · commit 96a6a66c26c0 · 2018-09-20T12:06:08.000-04:00
diff --git a/fetch2/src/main/java/com/tonyodev/fetch2/fetch/FetchHandlerImpl.kt b/fetch2/src/main/java/com/tonyodev/fetch2/fetch/FetchHandlerImpl.kt
@@ -522,6 +522,7 @@ class FetchHandlerImpl(private val namespace: String,
     }
 
     private fun startPriorityQueueIfNotStarted() {
+        priorityListProcessor.resetBackOffTime()
         if (priorityListProcessor.isStopped && !isTerminating) {
             priorityListProcessor.start()
         }
diff --git a/fetch2/src/main/java/com/tonyodev/fetch2/fetch/FetchModulesBuilder.kt b/fetch2/src/main/java/com/tonyodev/fetch2/fetch/FetchModulesBuilder.kt
@@ -47,7 +47,7 @@ object FetchModulesBuilder {
                 val newModules = Modules(fetchConfiguration, newHandlerWrapper, newDatabaseManager,
                         downloadManagerCoordinator, listenerCoordinator)
                 holderMap[fetchConfiguration.namespace] = Holder(newHandlerWrapper, newDatabaseManager,
-                        downloadManagerCoordinator, listenerCoordinator)
+                        downloadManagerCoordinator, listenerCoordinator, newModules.networkInfoProvider)
                 newModules
             }
             modules.handlerWrapper.incrementUsageCounter()
@@ -65,6 +65,7 @@ object FetchModulesBuilder {
                     holder.listenerCoordinator.clearAll()
                     holder.databaseManager.close()
                     holder.downloadManagerCoordinator.clearAll()
+                    holder.networkInfoProvider.unregisterAllNetworkBroadcastReceivers()
                     holderMap.remove(namespace)
                 }
             }
@@ -74,7 +75,8 @@ object FetchModulesBuilder {
     data class Holder(val handlerWrapper: HandlerWrapper,
                       val databaseManager: DatabaseManager,
                       val downloadManagerCoordinator: DownloadManagerCoordinator,
-                      val listenerCoordinator: ListenerCoordinator)
+                      val listenerCoordinator: ListenerCoordinator,
+                      val networkInfoProvider: NetworkInfoProvider)
 
     class Modules constructor(val fetchConfiguration: FetchConfiguration,
                               val handlerWrapper: HandlerWrapper,
diff --git a/fetch2/src/main/java/com/tonyodev/fetch2/helper/PriorityListProcessor.kt b/fetch2/src/main/java/com/tonyodev/fetch2/helper/PriorityListProcessor.kt
@@ -16,6 +16,7 @@ interface PriorityListProcessor<out T> {
     fun pause()
     fun resume()
     fun getPriorityList(): List<T>
+    fun resetBackOffTime()
 
     interface Delegate {
 
diff --git a/fetch2/src/main/java/com/tonyodev/fetch2/helper/PriorityListProcessorImpl.kt b/fetch2/src/main/java/com/tonyodev/fetch2/helper/PriorityListProcessorImpl.kt
@@ -1,15 +1,19 @@
 package com.tonyodev.fetch2.helper
 
+import android.content.BroadcastReceiver
+import android.content.Context
+import android.content.Intent
 import com.tonyodev.fetch2.*
 import com.tonyodev.fetch2.downloader.DownloadManager
 import com.tonyodev.fetch2core.HandlerWrapper
 import com.tonyodev.fetch2.provider.DownloadProvider
 import com.tonyodev.fetch2.provider.NetworkInfoProvider
-import com.tonyodev.fetch2.util.PRIORITY_QUEUE_INTERVAL_IN_MILLISECONDS
+import com.tonyodev.fetch2.util.DEFAULT_PRIORITY_QUEUE_INTERVAL_IN_MILLISECONDS
 import com.tonyodev.fetch2.NetworkType
 import com.tonyodev.fetch2.fetch.ListenerCoordinator
 import com.tonyodev.fetch2core.Logger
 import com.tonyodev.fetch2core.isFetchFileServerUrl
+import java.util.concurrent.TimeUnit
 
 class PriorityListProcessorImpl constructor(private val handlerWrapper: HandlerWrapper,
                                             private val downloadProvider: DownloadProvider,
@@ -33,10 +37,29 @@ class PriorityListProcessorImpl constructor(private val handlerWrapper: HandlerW
     private var stopped = true
     override val isStopped: Boolean
         get() = stopped
+    @Volatile
+    private var backOffTime = DEFAULT_PRIORITY_QUEUE_INTERVAL_IN_MILLISECONDS
+    private val networkBroadcastReceiver: BroadcastReceiver = object : BroadcastReceiver() {
+
+        override fun onReceive(context: Context?, intent: Intent?) {
+            if (context != null && !stopped && !paused && networkInfoProvider.isNetworkAvailable
+                    && backOffTime > DEFAULT_PRIORITY_QUEUE_INTERVAL_IN_MILLISECONDS) {
+                resetBackOffTime()
+            }
+        }
+    }
+
+    init {
+        networkInfoProvider.registerNetworkBroadcastReceiver(networkBroadcastReceiver)
+    }
+
     private val priorityIteratorRunnable = Runnable {
         if (canContinueToProcess()) {
             if (downloadManager.canAccommodateNewDownload() && canContinueToProcess()) {
                 val priorityList = getPriorityList()
+                if (priorityList.isEmpty() || !networkInfoProvider.isNetworkAvailable) {
+                    increaseBackOffTime()
+                }
                 delegate?.onHasActiveDownloads(priorityList.isNotEmpty())
                 for (index in 0..priorityList.lastIndex) {
                     if (downloadManager.canAccommodateNewDownload() && canContinueToProcess()) {
@@ -70,6 +93,7 @@ class PriorityListProcessorImpl constructor(private val handlerWrapper: HandlerW
 
     override fun start() {
         synchronized(lock) {
+            resetBackOffTime()
             stopped = false
             paused = false
             delegate?.onHasActiveDownloads(true)
@@ -101,6 +125,7 @@ class PriorityListProcessorImpl constructor(private val handlerWrapper: HandlerW
 
     override fun resume() {
         synchronized(lock) {
+            resetBackOffTime()
             paused = false
             stopped = false
             registerPriorityIterator()
@@ -121,7 +146,7 @@ class PriorityListProcessorImpl constructor(private val handlerWrapper: HandlerW
 
     private fun registerPriorityIterator() {
         if (downloadConcurrentLimit > 0) {
-            handlerWrapper.postDelayed(priorityIteratorRunnable, PRIORITY_QUEUE_INTERVAL_IN_MILLISECONDS)
+            handlerWrapper.postDelayed(priorityIteratorRunnable, backOffTime)
         }
     }
 
@@ -135,4 +160,27 @@ class PriorityListProcessorImpl constructor(private val handlerWrapper: HandlerW
         return !stopped && !paused
     }
 
+    override fun resetBackOffTime() {
+        synchronized(lock) {
+            backOffTime = DEFAULT_PRIORITY_QUEUE_INTERVAL_IN_MILLISECONDS
+            unregisterPriorityIterator()
+            registerPriorityIterator()
+            logger.d("PriorityIterator backoffTime reset to $backOffTime milliseconds")
+        }
+    }
+
+    private fun increaseBackOffTime() {
+        backOffTime = if (backOffTime == DEFAULT_PRIORITY_QUEUE_INTERVAL_IN_MILLISECONDS) {
+            ONE_MINUTE_IN_MILLISECONDS
+        } else {
+            backOffTime * 2L
+        }
+        val minutes = TimeUnit.MILLISECONDS.toMinutes(backOffTime)
+        logger.d("PriorityIterator backoffTime increased to $minutes minute(s)")
+    }
+
+    private companion object {
+        private const val ONE_MINUTE_IN_MILLISECONDS = 60000L
+    }
+
 }
diff --git a/fetch2/src/main/java/com/tonyodev/fetch2/provider/NetworkInfoProvider.kt b/fetch2/src/main/java/com/tonyodev/fetch2/provider/NetworkInfoProvider.kt
@@ -1,13 +1,56 @@
 package com.tonyodev.fetch2.provider
 
+import android.content.BroadcastReceiver
 import android.content.Context
+import android.content.IntentFilter
+import android.net.ConnectivityManager
 import com.tonyodev.fetch2.NetworkType
 import com.tonyodev.fetch2core.isNetworkAvailable
 import com.tonyodev.fetch2core.isOnWiFi
 
 
 class NetworkInfoProvider constructor(private val context: Context) {
 
+    private val lock = Any()
+    private val broadcastReceiverSet = mutableSetOf<BroadcastReceiver>()
+
+    fun registerNetworkBroadcastReceiver(broadcastReceiver: BroadcastReceiver) {
+        synchronized(lock) {
+            val intentFilter = IntentFilter(ConnectivityManager.CONNECTIVITY_ACTION)
+            try {
+                broadcastReceiverSet.add(broadcastReceiver)
+                context.registerReceiver(broadcastReceiver, intentFilter)
+            } catch (e: Exception) {
+
+            }
+        }
+    }
+
+    fun unregisterNetworkBroadcastReceiver(broadcastReceiver: BroadcastReceiver) {
+        synchronized(lock) {
+            try {
+                broadcastReceiverSet.remove(broadcastReceiver)
+                context.unregisterReceiver(broadcastReceiver)
+            } catch (e: Exception) {
+
+            }
+        }
+    }
+
+    fun unregisterAllNetworkBroadcastReceivers() {
+        synchronized(lock) {
+            val broadcastReceivers = broadcastReceiverSet.toList()
+            broadcastReceivers.forEach { broadcastReceiver ->
+                try {
+                    broadcastReceiverSet.remove(broadcastReceiver)
+                    context.unregisterReceiver(broadcastReceiver)
+                } catch (e: Exception) {
+
+                }
+            }
+        }
+    }
+
     fun isOnAllowedNetwork(networkType: NetworkType): Boolean {
         if (networkType == NetworkType.WIFI_ONLY && context.isOnWiFi()) {
             return true
diff --git a/fetch2/src/main/java/com/tonyodev/fetch2/util/Defaults.kt b/fetch2/src/main/java/com/tonyodev/fetch2/util/Defaults.kt
@@ -13,7 +13,7 @@ const val DEFAULT_UNIQUE_IDENTIFIER = 0L
 const val DEFAULT_DOWNLOAD_SPEED_REPORTING_INTERVAL_IN_MILLISECONDS = 1_000L
 const val DEFAULT_CONCURRENT_LIMIT = 1
 const val EMPTY_JSON_OBJECT_STRING = "{}"
-const val PRIORITY_QUEUE_INTERVAL_IN_MILLISECONDS = 500L
+const val DEFAULT_PRIORITY_QUEUE_INTERVAL_IN_MILLISECONDS = 500L
 const val DEFAULT_AUTO_START = true
 const val DEFAULT_RETRY_ON_NETWORK_GAIN = true
 const val DEFAULT_FILE_SLICE_NO_LIMIT_SET = -1

Original file line number	Diff line number	Diff line change
`@@ -522,6 +522,7 @@ class FetchHandlerImpl(private val namespace: String,`
`522`	`522`	`}`
`523`	`523`
`524`	`524`	`private fun startPriorityQueueIfNotStarted() {`
	`525`	`+ priorityListProcessor.resetBackOffTime()`
`525`	`526`	`if (priorityListProcessor.isStopped && !isTerminating) {`
`526`	`527`	`priorityListProcessor.start()`
`527`	`528`	`}`