aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/java/com/android/volley/DefaultRetryPolicy.java
diff options
context:
space:
mode:
Diffstat (limited to 'core/src/main/java/com/android/volley/DefaultRetryPolicy.java')
-rw-r--r--core/src/main/java/com/android/volley/DefaultRetryPolicy.java95
1 files changed, 95 insertions, 0 deletions
diff --git a/core/src/main/java/com/android/volley/DefaultRetryPolicy.java b/core/src/main/java/com/android/volley/DefaultRetryPolicy.java
new file mode 100644
index 0000000..4be6b50
--- /dev/null
+++ b/core/src/main/java/com/android/volley/DefaultRetryPolicy.java
@@ -0,0 +1,95 @@
+/*
+ * Copyright (C) 2011 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.volley;
+
+/** Default retry policy for requests. */
+public class DefaultRetryPolicy implements RetryPolicy {
+ /** The current timeout in milliseconds. */
+ private int mCurrentTimeoutMs;
+
+ /** The current retry count. */
+ private int mCurrentRetryCount;
+
+ /** The maximum number of attempts. */
+ private final int mMaxNumRetries;
+
+ /** The backoff multiplier for the policy. */
+ private final float mBackoffMultiplier;
+
+ /** The default socket timeout in milliseconds */
+ public static final int DEFAULT_TIMEOUT_MS = 2500;
+
+ /** The default number of retries */
+ public static final int DEFAULT_MAX_RETRIES = 1;
+
+ /** The default backoff multiplier */
+ public static final float DEFAULT_BACKOFF_MULT = 1f;
+
+ /** Constructs a new retry policy using the default timeouts. */
+ public DefaultRetryPolicy() {
+ this(DEFAULT_TIMEOUT_MS, DEFAULT_MAX_RETRIES, DEFAULT_BACKOFF_MULT);
+ }
+
+ /**
+ * Constructs a new retry policy.
+ *
+ * @param initialTimeoutMs The initial timeout for the policy.
+ * @param maxNumRetries The maximum number of retries.
+ * @param backoffMultiplier Backoff multiplier for the policy.
+ */
+ public DefaultRetryPolicy(int initialTimeoutMs, int maxNumRetries, float backoffMultiplier) {
+ mCurrentTimeoutMs = initialTimeoutMs;
+ mMaxNumRetries = maxNumRetries;
+ mBackoffMultiplier = backoffMultiplier;
+ }
+
+ /** Returns the current timeout. */
+ @Override
+ public int getCurrentTimeout() {
+ return mCurrentTimeoutMs;
+ }
+
+ /** Returns the current retry count. */
+ @Override
+ public int getCurrentRetryCount() {
+ return mCurrentRetryCount;
+ }
+
+ /** Returns the backoff multiplier for the policy. */
+ public float getBackoffMultiplier() {
+ return mBackoffMultiplier;
+ }
+
+ /**
+ * Prepares for the next retry by applying a backoff to the timeout.
+ *
+ * @param error The error code of the last attempt.
+ */
+ @Override
+ public void retry(VolleyError error) throws VolleyError {
+ mCurrentRetryCount++;
+ mCurrentTimeoutMs += (int) (mCurrentTimeoutMs * mBackoffMultiplier);
+ if (!hasAttemptRemaining()) {
+ throw error;
+ }
+ }
+
+ /** Returns true if this policy has attempts remaining, false otherwise. */
+ protected boolean hasAttemptRemaining() {
+ return mCurrentRetryCount <= mMaxNumRetries;
+ }
+}