1494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor/* 2494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Copyright (C) 2009 The Android Open Source Project 3494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 4494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Licensed under the Apache License, Version 2.0 (the "License"); 5494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * you may not use this file except in compliance with the License. 6494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * You may obtain a copy of the License at 7494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 8494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * http://www.apache.org/licenses/LICENSE-2.0 9494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 10494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Unless required by applicable law or agreed to in writing, software 11494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * distributed under the License is distributed on an "AS IS" BASIS, 12494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * See the License for the specific language governing permissions and 14494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * limitations under the License. 15494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 16494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 17494a1dc5e95e22839b06bf7de84426094a38691aDan Egnorpackage com.android.common; 18494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 19494a1dc5e95e22839b06bf7de84426094a38691aDan Egnorimport android.content.SharedPreferences; 207cfa90fee54f44831ac492891d1c123601c2a262Jesse Wilsonimport android.net.http.AndroidHttpClient; 21494a1dc5e95e22839b06bf7de84426094a38691aDan Egnorimport android.text.format.Time; 22494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 23494a1dc5e95e22839b06bf7de84426094a38691aDan Egnorimport java.util.Map; 24494a1dc5e95e22839b06bf7de84426094a38691aDan Egnorimport java.util.TreeSet; 25494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 26494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor/** 27494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Tracks the success/failure history of a particular network operation in 28494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * persistent storage and computes retry strategy accordingly. Handles 29494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * exponential backoff, periodic rescheduling, event-driven triggering, 30494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * retry-after moratorium intervals, etc. based on caller-specified parameters. 31494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 32494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * <p>This class does not directly perform or invoke any operations, 33494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * it only keeps track of the schedule. Somebody else needs to call 34494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * {@link #getNextTimeMillis()} as appropriate and do the actual work. 35494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 36494a1dc5e95e22839b06bf7de84426094a38691aDan Egnorpublic class OperationScheduler { 37494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** Tunable parameter options for {@link #getNextTimeMillis}. */ 38494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public static class Options { 39494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** Wait this long after every error before retrying. */ 40494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public long backoffFixedMillis = 0; 41494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 42494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** Wait this long times the number of consecutive errors so far before retrying. */ 43494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public long backoffIncrementalMillis = 5000; 44494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 45494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** Maximum duration of moratorium to honor. Mostly an issue for clock rollbacks. */ 46494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public long maxMoratoriumMillis = 24 * 3600 * 1000; 47494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 48494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** Minimum duration after success to wait before allowing another trigger. */ 49494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public long minTriggerMillis = 0; 50494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 51494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** Automatically trigger this long after the last success. */ 52494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public long periodicIntervalMillis = 0; 53494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 54494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor @Override 55494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public String toString() { 56494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor return String.format( 57494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor "OperationScheduler.Options[backoff=%.1f+%.1f max=%.1f min=%.1f period=%.1f]", 58494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor backoffFixedMillis / 1000.0, backoffIncrementalMillis / 1000.0, 59494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor maxMoratoriumMillis / 1000.0, minTriggerMillis / 1000.0, 60494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor periodicIntervalMillis / 1000.0); 61494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 62494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 63494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 64494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor private static final String PREFIX = "OperationScheduler_"; 65494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor private final SharedPreferences mStorage; 66494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 67494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 68494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Initialize the scheduler state. 69494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @param storage to use for recording the state of operations across restarts/reboots 70494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 71494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public OperationScheduler(SharedPreferences storage) { 72494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor mStorage = storage; 73494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 74494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 75494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 76494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Parse scheduler options supplied in this string form: 77494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 78494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * <pre> 79494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * backoff=(fixed)+(incremental) max=(maxmoratorium) min=(mintrigger) [period=](interval) 80494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * </pre> 81494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 82494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * All values are times in (possibly fractional) <em>seconds</em> (not milliseconds). 83494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Omitted settings are left at whatever existing default value was passed in. 84494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 85494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * <p> 86494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * The default options: <code>backoff=0+5 max=86400 min=0 period=0</code><br> 87494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Fractions are OK: <code>backoff=+2.5 period=10.0</code><br> 88494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * The "period=" can be omitted: <code>3600</code><br> 89494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 90494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @param spec describing some or all scheduler options. 91494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @param options to update with parsed values. 92494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @return the options passed in (for convenience) 93494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @throws IllegalArgumentException if the syntax is invalid 94494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 95494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public static Options parseOptions(String spec, Options options) 96494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor throws IllegalArgumentException { 97494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor for (String param : spec.split(" +")) { 98494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor if (param.length() == 0) continue; 99494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor if (param.startsWith("backoff=")) { 100494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor int plus = param.indexOf('+', 8); 101494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor if (plus < 0) { 102494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor options.backoffFixedMillis = parseSeconds(param.substring(8)); 103494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } else { 104494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor if (plus > 8) { 105494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor options.backoffFixedMillis = parseSeconds(param.substring(8, plus)); 106494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 107494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor options.backoffIncrementalMillis = parseSeconds(param.substring(plus + 1)); 108494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 109494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } else if (param.startsWith("max=")) { 110494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor options.maxMoratoriumMillis = parseSeconds(param.substring(4)); 111494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } else if (param.startsWith("min=")) { 112494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor options.minTriggerMillis = parseSeconds(param.substring(4)); 113494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } else if (param.startsWith("period=")) { 114494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor options.periodicIntervalMillis = parseSeconds(param.substring(7)); 115494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } else { 116494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor options.periodicIntervalMillis = parseSeconds(param); 117494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 118494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 119494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor return options; 120494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 121494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 122494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor private static long parseSeconds(String param) throws NumberFormatException { 123494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor return (long) (Float.parseFloat(param) * 1000); 124494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 125494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 126494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 127d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor * Compute the time of the next operation. Does not modify any state 128d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor * (unless the clock rolls backwards, in which case timers are reset). 129494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 130494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @param options to use for this computation. 131494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @return the wall clock time ({@link System#currentTimeMillis()}) when the 132494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * next operation should be attempted -- immediately, if the return value is 133494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * before the current time. 134494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 135494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public long getNextTimeMillis(Options options) { 136494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor boolean enabledState = mStorage.getBoolean(PREFIX + "enabledState", true); 137494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor if (!enabledState) return Long.MAX_VALUE; 138494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 139494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor boolean permanentError = mStorage.getBoolean(PREFIX + "permanentError", false); 140494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor if (permanentError) return Long.MAX_VALUE; 141494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 142494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor // We do quite a bit of limiting to prevent a clock rollback from totally 143494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor // hosing the scheduler. Times which are supposed to be in the past are 144494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor // clipped to the current time so we don't languish forever. 145494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 146494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor int errorCount = mStorage.getInt(PREFIX + "errorCount", 0); 147d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor long now = currentTimeMillis(); 148494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor long lastSuccessTimeMillis = getTimeBefore(PREFIX + "lastSuccessTimeMillis", now); 149494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor long lastErrorTimeMillis = getTimeBefore(PREFIX + "lastErrorTimeMillis", now); 150494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor long triggerTimeMillis = mStorage.getLong(PREFIX + "triggerTimeMillis", Long.MAX_VALUE); 151d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor long moratoriumSetMillis = getTimeBefore(PREFIX + "moratoriumSetTimeMillis", now); 152494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor long moratoriumTimeMillis = getTimeBefore(PREFIX + "moratoriumTimeMillis", 153494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor moratoriumSetMillis + options.maxMoratoriumMillis); 154494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 155494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor long time = triggerTimeMillis; 156494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor if (options.periodicIntervalMillis > 0) { 157494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor time = Math.min(time, lastSuccessTimeMillis + options.periodicIntervalMillis); 158494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 159d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor 160d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor time = Math.max(time, moratoriumTimeMillis); 161494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor time = Math.max(time, lastSuccessTimeMillis + options.minTriggerMillis); 1628a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor if (errorCount > 0) { 1638a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor time = Math.max(time, lastErrorTimeMillis + options.backoffFixedMillis + 1648a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor options.backoffIncrementalMillis * errorCount); 1658a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor } 166494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor return time; 167494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 168494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 169494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 1708a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor * Return the last time the operation completed. Does not modify any state. 1718a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor * 1728a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor * @return the wall clock time when {@link #onSuccess()} was last called. 1738a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor */ 1748a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor public long getLastSuccessTimeMillis() { 1758a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor return mStorage.getLong(PREFIX + "lastSuccessTimeMillis", 0); 1768a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor } 1778a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor 1788a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor /** 1798a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor * Return the last time the operation was attempted. Does not modify any state. 1808a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor * 1818a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor * @return the wall clock time when {@link #onSuccess()} or {@link 1828a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor * #onTransientError()} was last called. 1838a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor */ 1848a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor public long getLastAttemptTimeMillis() { 1858a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor return Math.max( 1868a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor mStorage.getLong(PREFIX + "lastSuccessTimeMillis", 0), 1878a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor mStorage.getLong(PREFIX + "lastErrorTimeMillis", 0)); 1888a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor } 1898a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor 1908a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor /** 191494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Fetch a {@link SharedPreferences} property, but force it to be before 192494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * a certain time, updating the value if necessary. This is to recover 193494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * gracefully from clock rollbacks which could otherwise strand our timers. 194494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 195494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @param name of SharedPreferences key 196494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @param max time to allow in result 197494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @return current value attached to key (default 0), limited by max 198494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 199494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor private long getTimeBefore(String name, long max) { 200494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor long time = mStorage.getLong(name, 0); 201494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor if (time > max) mStorage.edit().putLong(name, (time = max)).commit(); 202494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor return time; 203494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 204494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 205494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 206494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Request an operation to be performed at a certain time. The actual 207494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * scheduled time may be affected by error backoff logic and defined 208d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor * minimum intervals. Use {@link Long#MAX_VALUE} to disable triggering. 209494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 210494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @param millis wall clock time ({@link System#currentTimeMillis()}) to 211494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * trigger another operation; 0 to trigger immediately 212494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 213494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public void setTriggerTimeMillis(long millis) { 214494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor mStorage.edit().putLong(PREFIX + "triggerTimeMillis", millis).commit(); 215494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 216494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 217494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 218494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Forbid any operations until after a certain (absolute) time. 219494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Limited by {@link #Options.maxMoratoriumMillis}. 220494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 221d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor * @param millis wall clock time ({@link System#currentTimeMillis()}) 222d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor * when operations should be allowed again; 0 to remove moratorium 223494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 224494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public void setMoratoriumTimeMillis(long millis) { 225494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor mStorage.edit() 226494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor .putLong(PREFIX + "moratoriumTimeMillis", millis) 227d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor .putLong(PREFIX + "moratoriumSetTimeMillis", currentTimeMillis()) 228494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor .commit(); 229494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 230494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 231494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 2322991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor * Forbid any operations until after a certain time, as specified in 2332991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor * the format used by the HTTP "Retry-After" header. 2342991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor * Limited by {@link #Options.maxMoratoriumMillis}. 2352991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor * 2362991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor * @param retryAfter moratorium time in HTTP format 2372991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor * @return true if a time was successfully parsed 2382991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor */ 2392991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor public boolean setMoratoriumTimeHttp(String retryAfter) { 2402991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor try { 2412991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor long ms = Long.valueOf(retryAfter) * 1000; 242d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor setMoratoriumTimeMillis(ms + currentTimeMillis()); 2432991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor return true; 2442991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor } catch (NumberFormatException nfe) { 2452991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor try { 2467cfa90fee54f44831ac492891d1c123601c2a262Jesse Wilson setMoratoriumTimeMillis(AndroidHttpClient.parseDate(retryAfter)); 2472991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor return true; 2482991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor } catch (IllegalArgumentException iae) { 2492991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor return false; 2502991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor } 2512991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor } 2522991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor } 2532991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor 2542991425379efd0bc29bce6cd718e5833cc6aa59bDan Egnor /** 255494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Enable or disable all operations. When disabled, all calls to 256494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * {@link #getNextTimeMillis()} return {@link Long#MAX_VALUE}. 257494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Commonly used when data network availability goes up and down. 258494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * 259494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * @param enabled if operations can be performed 260494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 261494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public void setEnabledState(boolean enabled) { 262494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor mStorage.edit().putBoolean(PREFIX + "enabledState", enabled).commit(); 263494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 264494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 265494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 266494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Report successful completion of an operation. Resets all error 267494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * counters, clears any trigger directives, and records the success. 268494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 269494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public void onSuccess() { 270494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor resetTransientError(); 271494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor resetPermanentError(); 272494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor mStorage.edit() 273494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor .remove(PREFIX + "errorCount") 274494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor .remove(PREFIX + "lastErrorTimeMillis") 275494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor .remove(PREFIX + "permanentError") 276494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor .remove(PREFIX + "triggerTimeMillis") 277d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor .putLong(PREFIX + "lastSuccessTimeMillis", currentTimeMillis()).commit(); 278494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 279494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 280494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 281494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Report a transient error (usually a network failure). Increments 282494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * the error count and records the time of the latest error for backoff 283494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * purposes. 284494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 285494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public void onTransientError() { 286d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor mStorage.edit().putLong(PREFIX + "lastErrorTimeMillis", currentTimeMillis()).commit(); 287494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor mStorage.edit().putInt(PREFIX + "errorCount", 288494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor mStorage.getInt(PREFIX + "errorCount", 0) + 1).commit(); 289494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 290494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 291494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 292494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Reset all transient error counts, allowing the next operation to proceed 293494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * immediately without backoff. Commonly used on network state changes, when 294494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * partial progress occurs (some data received), and in other circumstances 295494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * where there is reason to hope things might start working better. 296494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 297494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public void resetTransientError() { 2988a2e0111958b9f6b665d0ed9a6d8bceb9d8fa31aDan Egnor mStorage.edit().remove(PREFIX + "errorCount").commit(); 299494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 300494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 301494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 302494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Report a permanent error that will not go away until further notice. 303494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * No operation will be scheduled until {@link #resetPermanentError()} 304494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * is called. Commonly used for authentication failures (which are reset 305494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * when the accounts database is updated). 306494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 307494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public void onPermanentError() { 308494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor mStorage.edit().putBoolean(PREFIX + "permanentError", true).commit(); 309494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 310494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 311494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 312494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Reset any permanent error status set by {@link #onPermanentError}, 313494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * allowing operations to be scheduled as normal. 314494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 315494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public void resetPermanentError() { 316494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor mStorage.edit().remove(PREFIX + "permanentError").commit(); 317494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 318494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor 319494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor /** 320494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor * Return a string description of the scheduler state for debugging. 321494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor */ 322494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor public String toString() { 323494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor StringBuilder out = new StringBuilder("[OperationScheduler:"); 324494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor for (String key : new TreeSet<String>(mStorage.getAll().keySet())) { // Sort keys 325494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor if (key.startsWith(PREFIX)) { 326494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor if (key.endsWith("TimeMillis")) { 327494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor Time time = new Time(); 328494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor time.set(mStorage.getLong(key, 0)); 329494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor out.append(" ").append(key.substring(PREFIX.length(), key.length() - 10)); 330494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor out.append("=").append(time.format("%Y-%m-%d/%H:%M:%S")); 331494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } else { 332494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor out.append(" ").append(key.substring(PREFIX.length())); 333494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor out.append("=").append(mStorage.getAll().get(key).toString()); 334494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 335494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 336494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 337494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor return out.append("]").toString(); 338494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor } 339d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor 340d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor /** 341d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor * Gets the current time. Can be overridden for unit testing. 342d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor * 343d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor * @return {@link System#currentTimeMillis()} 344d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor */ 345d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor protected long currentTimeMillis() { 346d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor return System.currentTimeMillis(); 347d64567450f3ea4d298a8781ebbabf32b02ebb520Dan Egnor } 348494a1dc5e95e22839b06bf7de84426094a38691aDan Egnor} 349