Package org.projectnessie.versioned.persist.adapter.spi

Class TryLoopState

java.lang.Object

org.projectnessie.versioned.persist.adapter.spi.TryLoopState

All Implemented Interfaces:

java.lang.AutoCloseable

public class TryLoopState
extends java.lang.Object
implements java.lang.AutoCloseable

Retry-logic for attempts for compare-and-swap-like operations.

Method Summary

Modifier and Type	Method	Description
void	close()
long	getDuration(java.util.concurrent.TimeUnit timeUnit)
int	getEndlessRetries()
int	getRetries()
int	getTotalRetries()
static TryLoopState	newTryLoopState(java.lang.String opName, java.util.function.Function<TryLoopState,java.lang.String> retryErrorMessage, java.util.function.BiConsumer<java.lang.Boolean,TryLoopState> completionNotifier, DatabaseAdapterConfig config)
void	resetBounds()
void	retry()	Called when a database-adapter operation needs to retry due to a concurrent-modification / CAS failure.
void	retryEndless()	Similar to retry(), but never throws a ReferenceRetryFailureException (unless a preceding call to retry() already raised it).
org.projectnessie.versioned.Hash	success(org.projectnessie.versioned.Hash result)	Called when the operation succeeded.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newTryLoopState

public static TryLoopState newTryLoopState(java.lang.String opName,
                                           java.util.function.Function<TryLoopState,java.lang.String> retryErrorMessage,
                                           java.util.function.BiConsumer<java.lang.Boolean,TryLoopState> completionNotifier,
                                           DatabaseAdapterConfig config)

getRetries

public int getRetries()

getEndlessRetries

public int getEndlessRetries()

getTotalRetries

public int getTotalRetries()

getDuration

public long getDuration(java.util.concurrent.TimeUnit timeUnit)

success

public org.projectnessie.versioned.Hash success(org.projectnessie.versioned.Hash result)

Called when the operation succeeded. The current implementation is rather a no-op, but can be used to track/trace/monitor successes.

retry

public void retry()
           throws org.projectnessie.versioned.ReferenceRetryFailureException

Called when a database-adapter operation needs to retry due to a concurrent-modification / CAS failure.

If this method just returns, the called can safely retry. If this method throws a ReferenceRetryFailureException, the total time and/or maximum allowed number of retries exceeded the configured values.

Throws:

org.projectnessie.versioned.ReferenceRetryFailureException

resetBounds

public void resetBounds()

retryEndless

public void retryEndless()
                  throws org.projectnessie.versioned.ReferenceRetryFailureException

Similar to retry(), but never throws a ReferenceRetryFailureException (unless a preceding call to retry() already raised it).

Throws:

org.projectnessie.versioned.ReferenceRetryFailureException

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable