Skip to content

Commit

Permalink
Flesh out RetryPolicy's Javadoc.
Browse files Browse the repository at this point in the history
Make it clear that there is no supported way to configure a retry
policy which will induce a delay between tries with the current API.

See google#80
  • Loading branch information
jpd236 committed May 30, 2018
1 parent 0819be6 commit 9c0180a
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion src/main/java/com/android/volley/RetryPolicy.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,27 @@

package com.android.volley;

/** Retry policy for a request. */
/**
* Retry policy for a request.
*
* <p>A retry policy can control two parameters:
*
* <ul>
* <li>The number of tries. This can be a simple counter or more complex logic based on the type
* of error passed to {@link #retry(VolleyError)}, although {@link #getCurrentRetryCount()}
* should always return the current retry count for logging purposes.
* <li>The request timeout for each try, via {@link #getCurrentTimeout()}. In the common case that
* a request times out before the response has been received from the server, retrying again
* with a longer timeout can increase the likelihood of success (at the expense of causing the
* user to wait longer, especially if the request still fails).
* </ul>
*
* <p>Note that currently, retries triggered by a retry policy are attempted immediately in sequence
* with no delay between them (although the time between tries may increase if the requests are
* timing out and {@link #getCurrentTimeout()} is returning increasing values).
*
* <p>By default, Volley uses {@link DefaultRetryPolicy}.
*/
public interface RetryPolicy {

/** Returns the current timeout (used for logging). */
Expand Down

0 comments on commit 9c0180a

Please sign in to comment.