1823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang/* 2823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Copyright (C) 2009 The Android Open Source Project 3823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 4823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Licensed under the Apache License, Version 2.0 (the "License"); 5823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * you may not use this file except in compliance with the License. 6823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * You may obtain a copy of the License at 7823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 8823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * http://www.apache.org/licenses/LICENSE-2.0 9823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 10823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Unless required by applicable law or agreed to in writing, software 11823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * distributed under the License is distributed on an "AS IS" BASIS, 12823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * See the License for the specific language governing permissions and 14823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * limitations under the License. 15823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 16823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 17823b6f3516076b92f78c3fc27037d24bb514e653Ying Wangpackage com.android.common; 18823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 19823b6f3516076b92f78c3fc27037d24bb514e653Ying Wangimport android.content.SharedPreferences; 20823b6f3516076b92f78c3fc27037d24bb514e653Ying Wangimport android.net.http.AndroidHttpClient; 21823b6f3516076b92f78c3fc27037d24bb514e653Ying Wangimport android.text.format.Time; 22823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 23823b6f3516076b92f78c3fc27037d24bb514e653Ying Wangimport java.util.Map; 24823b6f3516076b92f78c3fc27037d24bb514e653Ying Wangimport java.util.TreeSet; 25823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 26823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang/** 27823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Tracks the success/failure history of a particular network operation in 28823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * persistent storage and computes retry strategy accordingly. Handles 29823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * exponential backoff, periodic rescheduling, event-driven triggering, 30823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * retry-after moratorium intervals, etc. based on caller-specified parameters. 31823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 32823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * <p>This class does not directly perform or invoke any operations, 33823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * it only keeps track of the schedule. Somebody else needs to call 34823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * {@link #getNextTimeMillis()} as appropriate and do the actual work. 35823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 36823b6f3516076b92f78c3fc27037d24bb514e653Ying Wangpublic class OperationScheduler { 37823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** Tunable parameter options for {@link #getNextTimeMillis}. */ 38823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public static class Options { 39823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** Wait this long after every error before retrying. */ 40823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public long backoffFixedMillis = 0; 41823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 42823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** Wait this long times the number of consecutive errors so far before retrying. */ 43823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public long backoffIncrementalMillis = 5000; 44823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 45823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** Maximum duration of moratorium to honor. Mostly an issue for clock rollbacks. */ 46823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public long maxMoratoriumMillis = 24 * 3600 * 1000; 47823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 48823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** Minimum duration after success to wait before allowing another trigger. */ 49823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public long minTriggerMillis = 0; 50823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 51823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** Automatically trigger this long after the last success. */ 52823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public long periodicIntervalMillis = 0; 53823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 54823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang @Override 55823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public String toString() { 56823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return String.format( 57823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang "OperationScheduler.Options[backoff=%.1f+%.1f max=%.1f min=%.1f period=%.1f]", 58823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang backoffFixedMillis / 1000.0, backoffIncrementalMillis / 1000.0, 59823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang maxMoratoriumMillis / 1000.0, minTriggerMillis / 1000.0, 60823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang periodicIntervalMillis / 1000.0); 61823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 62823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 63823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 64823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang private static final String PREFIX = "OperationScheduler_"; 65823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang private final SharedPreferences mStorage; 66823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 67823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 68823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Initialize the scheduler state. 69823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @param storage to use for recording the state of operations across restarts/reboots 70823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 71823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public OperationScheduler(SharedPreferences storage) { 72823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang mStorage = storage; 73823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 74823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 75823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 76823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Parse scheduler options supplied in this string form: 77823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 78823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * <pre> 79823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * backoff=(fixed)+(incremental) max=(maxmoratorium) min=(mintrigger) [period=](interval) 80823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * </pre> 81823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 82823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * All values are times in (possibly fractional) <em>seconds</em> (not milliseconds). 83823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Omitted settings are left at whatever existing default value was passed in. 84823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 85823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * <p> 86823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * The default options: <code>backoff=0+5 max=86400 min=0 period=0</code><br> 87823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Fractions are OK: <code>backoff=+2.5 period=10.0</code><br> 88823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * The "period=" can be omitted: <code>3600</code><br> 89823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 90823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @param spec describing some or all scheduler options. 91823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @param options to update with parsed values. 92823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @return the options passed in (for convenience) 93823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @throws IllegalArgumentException if the syntax is invalid 94823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 95823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public static Options parseOptions(String spec, Options options) 96823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang throws IllegalArgumentException { 97823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang for (String param : spec.split(" +")) { 98823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang if (param.length() == 0) continue; 99823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang if (param.startsWith("backoff=")) { 100823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang int plus = param.indexOf('+', 8); 101823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang if (plus < 0) { 102823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang options.backoffFixedMillis = parseSeconds(param.substring(8)); 103823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } else { 104823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang if (plus > 8) { 105823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang options.backoffFixedMillis = parseSeconds(param.substring(8, plus)); 106823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 107823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang options.backoffIncrementalMillis = parseSeconds(param.substring(plus + 1)); 108823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 109823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } else if (param.startsWith("max=")) { 110823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang options.maxMoratoriumMillis = parseSeconds(param.substring(4)); 111823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } else if (param.startsWith("min=")) { 112823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang options.minTriggerMillis = parseSeconds(param.substring(4)); 113823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } else if (param.startsWith("period=")) { 114823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang options.periodicIntervalMillis = parseSeconds(param.substring(7)); 115823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } else { 116823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang options.periodicIntervalMillis = parseSeconds(param); 117823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 118823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 119823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return options; 120823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 121823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 122823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang private static long parseSeconds(String param) throws NumberFormatException { 123823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return (long) (Float.parseFloat(param) * 1000); 124823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 125823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 126823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 127823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Compute the time of the next operation. Does not modify any state 128823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * (unless the clock rolls backwards, in which case timers are reset). 129823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 130823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @param options to use for this computation. 131823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @return the wall clock time ({@link System#currentTimeMillis()}) when the 132823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * next operation should be attempted -- immediately, if the return value is 133823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * before the current time. 134823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 135823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public long getNextTimeMillis(Options options) { 136823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang boolean enabledState = mStorage.getBoolean(PREFIX + "enabledState", true); 137823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang if (!enabledState) return Long.MAX_VALUE; 138823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 139823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang boolean permanentError = mStorage.getBoolean(PREFIX + "permanentError", false); 140823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang if (permanentError) return Long.MAX_VALUE; 141823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 142823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang // We do quite a bit of limiting to prevent a clock rollback from totally 143823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang // hosing the scheduler. Times which are supposed to be in the past are 144823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang // clipped to the current time so we don't languish forever. 145823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 146823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang int errorCount = mStorage.getInt(PREFIX + "errorCount", 0); 147823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang long now = currentTimeMillis(); 148823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang long lastSuccessTimeMillis = getTimeBefore(PREFIX + "lastSuccessTimeMillis", now); 149823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang long lastErrorTimeMillis = getTimeBefore(PREFIX + "lastErrorTimeMillis", now); 150823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang long triggerTimeMillis = mStorage.getLong(PREFIX + "triggerTimeMillis", Long.MAX_VALUE); 151823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang long moratoriumSetMillis = getTimeBefore(PREFIX + "moratoriumSetTimeMillis", now); 152823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang long moratoriumTimeMillis = getTimeBefore(PREFIX + "moratoriumTimeMillis", 153823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang moratoriumSetMillis + options.maxMoratoriumMillis); 154823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 155823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang long time = triggerTimeMillis; 156823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang if (options.periodicIntervalMillis > 0) { 157823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang time = Math.min(time, lastSuccessTimeMillis + options.periodicIntervalMillis); 158823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 159823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 160823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang time = Math.max(time, moratoriumTimeMillis); 161823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang time = Math.max(time, lastSuccessTimeMillis + options.minTriggerMillis); 162823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang if (errorCount > 0) { 163823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang time = Math.max(time, lastErrorTimeMillis + options.backoffFixedMillis + 164823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang options.backoffIncrementalMillis * errorCount); 165823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 166823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return time; 167823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 168823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 169823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 170823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Return the last time the operation completed. Does not modify any state. 171823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 172823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @return the wall clock time when {@link #onSuccess()} was last called. 173823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 174823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public long getLastSuccessTimeMillis() { 175823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return mStorage.getLong(PREFIX + "lastSuccessTimeMillis", 0); 176823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 177823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 178823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 179823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Return the last time the operation was attempted. Does not modify any state. 180823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 181823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @return the wall clock time when {@link #onSuccess()} or {@link 182823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * #onTransientError()} was last called. 183823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 184823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public long getLastAttemptTimeMillis() { 185823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return Math.max( 186823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang mStorage.getLong(PREFIX + "lastSuccessTimeMillis", 0), 187823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang mStorage.getLong(PREFIX + "lastErrorTimeMillis", 0)); 188823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 189823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 190823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 191823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Fetch a {@link SharedPreferences} property, but force it to be before 192823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * a certain time, updating the value if necessary. This is to recover 193823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * gracefully from clock rollbacks which could otherwise strand our timers. 194823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 195823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @param name of SharedPreferences key 196823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @param max time to allow in result 197823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @return current value attached to key (default 0), limited by max 198823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 199823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang private long getTimeBefore(String name, long max) { 200823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang long time = mStorage.getLong(name, 0); 201575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick if (time > max) { 202575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick time = max; 203575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick SharedPreferencesCompat.apply(mStorage.edit().putLong(name, time)); 204575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick } 205823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return time; 206823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 207823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 208823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 209823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Request an operation to be performed at a certain time. The actual 210823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * scheduled time may be affected by error backoff logic and defined 211823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * minimum intervals. Use {@link Long#MAX_VALUE} to disable triggering. 212823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 213823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @param millis wall clock time ({@link System#currentTimeMillis()}) to 214823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * trigger another operation; 0 to trigger immediately 215823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 216823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public void setTriggerTimeMillis(long millis) { 217575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick SharedPreferencesCompat.apply( 218575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick mStorage.edit().putLong(PREFIX + "triggerTimeMillis", millis)); 219823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 220823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 221823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 222823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Forbid any operations until after a certain (absolute) time. 223823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Limited by {@link #Options.maxMoratoriumMillis}. 224823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 225823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @param millis wall clock time ({@link System#currentTimeMillis()}) 226823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * when operations should be allowed again; 0 to remove moratorium 227823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 228823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public void setMoratoriumTimeMillis(long millis) { 229575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick SharedPreferencesCompat.apply(mStorage.edit() 230575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick .putLong(PREFIX + "moratoriumTimeMillis", millis) 231575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick .putLong(PREFIX + "moratoriumSetTimeMillis", currentTimeMillis())); 232823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 233823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 234823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 235823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Forbid any operations until after a certain time, as specified in 236823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * the format used by the HTTP "Retry-After" header. 237823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Limited by {@link #Options.maxMoratoriumMillis}. 238823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 239823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @param retryAfter moratorium time in HTTP format 240823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @return true if a time was successfully parsed 241823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 242823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public boolean setMoratoriumTimeHttp(String retryAfter) { 243823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang try { 244823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang long ms = Long.valueOf(retryAfter) * 1000; 245823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang setMoratoriumTimeMillis(ms + currentTimeMillis()); 246823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return true; 247823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } catch (NumberFormatException nfe) { 248823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang try { 249823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang setMoratoriumTimeMillis(AndroidHttpClient.parseDate(retryAfter)); 250823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return true; 251823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } catch (IllegalArgumentException iae) { 252823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return false; 253823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 254823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 255823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 256823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 257823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 258823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Enable or disable all operations. When disabled, all calls to 259823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * {@link #getNextTimeMillis()} return {@link Long#MAX_VALUE}. 260823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Commonly used when data network availability goes up and down. 261823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 262823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @param enabled if operations can be performed 263823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 264823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public void setEnabledState(boolean enabled) { 265575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick SharedPreferencesCompat.apply( 266575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick mStorage.edit().putBoolean(PREFIX + "enabledState", enabled)); 267823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 268823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 269823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 270823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Report successful completion of an operation. Resets all error 271823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * counters, clears any trigger directives, and records the success. 272823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 273823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public void onSuccess() { 274823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang resetTransientError(); 275823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang resetPermanentError(); 276575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick SharedPreferencesCompat.apply(mStorage.edit() 277823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang .remove(PREFIX + "errorCount") 278823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang .remove(PREFIX + "lastErrorTimeMillis") 279823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang .remove(PREFIX + "permanentError") 280823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang .remove(PREFIX + "triggerTimeMillis") 281575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick .putLong(PREFIX + "lastSuccessTimeMillis", currentTimeMillis())); 282823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 283823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 284823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 285823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Report a transient error (usually a network failure). Increments 286823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * the error count and records the time of the latest error for backoff 287823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * purposes. 288823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 289823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public void onTransientError() { 290575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick SharedPreferences.Editor editor = mStorage.edit(); 291575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick editor.putLong(PREFIX + "lastErrorTimeMillis", currentTimeMillis()); 292575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick editor.putInt(PREFIX + "errorCount", 293575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick mStorage.getInt(PREFIX + "errorCount", 0) + 1); 294575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick SharedPreferencesCompat.apply(editor); 295823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 296823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 297823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 298823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Reset all transient error counts, allowing the next operation to proceed 299823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * immediately without backoff. Commonly used on network state changes, when 300823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * partial progress occurs (some data received), and in other circumstances 301823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * where there is reason to hope things might start working better. 302823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 303823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public void resetTransientError() { 304575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick SharedPreferencesCompat.apply(mStorage.edit().remove(PREFIX + "errorCount")); 305823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 306823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 307823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 308823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Report a permanent error that will not go away until further notice. 309823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * No operation will be scheduled until {@link #resetPermanentError()} 310823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * is called. Commonly used for authentication failures (which are reset 311823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * when the accounts database is updated). 312823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 313823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public void onPermanentError() { 314575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick SharedPreferencesCompat.apply(mStorage.edit().putBoolean(PREFIX + "permanentError", true)); 315823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 316823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 317823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 318823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Reset any permanent error status set by {@link #onPermanentError}, 319823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * allowing operations to be scheduled as normal. 320823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 321823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public void resetPermanentError() { 322575e19825099eb83d1d452ffce93314aa66432edBrad Fitzpatrick SharedPreferencesCompat.apply(mStorage.edit().remove(PREFIX + "permanentError")); 323823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 324823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 325823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 326823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Return a string description of the scheduler state for debugging. 327823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 328823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang public String toString() { 329823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang StringBuilder out = new StringBuilder("[OperationScheduler:"); 330823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang for (String key : new TreeSet<String>(mStorage.getAll().keySet())) { // Sort keys 331823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang if (key.startsWith(PREFIX)) { 332823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang if (key.endsWith("TimeMillis")) { 333823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang Time time = new Time(); 334823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang time.set(mStorage.getLong(key, 0)); 335823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang out.append(" ").append(key.substring(PREFIX.length(), key.length() - 10)); 336823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang out.append("=").append(time.format("%Y-%m-%d/%H:%M:%S")); 337823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } else { 338823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang out.append(" ").append(key.substring(PREFIX.length())); 339823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang out.append("=").append(mStorage.getAll().get(key).toString()); 340823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 341823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 342823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 343823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return out.append("]").toString(); 344823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 345823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang 346823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang /** 347823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * Gets the current time. Can be overridden for unit testing. 348823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * 349823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang * @return {@link System#currentTimeMillis()} 350823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang */ 351823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang protected long currentTimeMillis() { 352823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang return System.currentTimeMillis(); 353823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang } 354823b6f3516076b92f78c3fc27037d24bb514e653Ying Wang} 355