public class RetryLoop
extends java.lang.Object
Mechanism to perform an operation on Zookeeper that is safe against disconnections and "recoverable" errors.
If an exception occurs during the operation, the RetryLoop will process it, check with the current retry policy and either attempt to reconnect or re-throw the exception
Canonical usage:
RetryLoop retryLoop = client.newRetryLoop();
while ( retryLoop.shouldContinue() )
{
try
{
// do your work
ZooKeeper zk = client.getZooKeeper(); // it's important to re-get the ZK instance in case there was an error and the instance was re-created
retryLoop.markComplete();
}
catch ( Exception e )
{
retryLoop.takeException(e);
}
}
Modifier and Type | Method and Description |
---|---|
static <T> T |
callWithRetry(CuratorZookeeperClient client,
java.util.concurrent.Callable<T> proc)
Convenience utility: creates a retry loop calling the given proc and retrying if needed
|
static RetrySleeper |
getDefaultRetrySleeper()
Returns the default retry sleeper
|
static boolean |
isRetryException(java.lang.Throwable exception)
Utility - return true if the given exception is retry-able
|
void |
markComplete()
Call this when your operation has successfully completed
|
boolean |
shouldContinue()
If true is returned, make an attempt at the operation
|
static boolean |
shouldRetry(int rc)
Utility - return true if the given Zookeeper result code is retry-able
|
void |
takeException(java.lang.Exception exception)
Pass any caught exceptions here
|
public static RetrySleeper getDefaultRetrySleeper()
public static <T> T callWithRetry(CuratorZookeeperClient client, java.util.concurrent.Callable<T> proc) throws java.lang.Exception
T
- return typeclient
- Zookeeperproc
- procedure to call with retryjava.lang.Exception
- any non-retriable errorspublic boolean shouldContinue()
public void markComplete()
public static boolean shouldRetry(int rc)
rc
- result codepublic static boolean isRetryException(java.lang.Throwable exception)
exception
- exception to checkpublic void takeException(java.lang.Exception exception) throws java.lang.Exception
exception
- the exceptionjava.lang.Exception
- if not retry-able or the retry policy returned negative