org.tikv.common.util

Class ConcreteBackOffer

java.lang.Object

org.tikv.common.util.ConcreteBackOffer

All Implemented Interfaces:

BackOffer

public class ConcreteBackOffer
extends Object
implements BackOffer

Nested Class Summary

Nested classes/interfaces inherited from interface org.tikv.common.util.BackOffer

BackOffer.BackOffStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static io.prometheus.client.Histogram	BACKOFF_DURATION
Map<BackOffFunction.BackOffFuncType,BackOffFunction>	backOffFunctionMap
List<Exception>	errors

Fields inherited from interface org.tikv.common.util.BackOffer

BATCH_GET_MAX_BACKOFF, COP_NEXT_MAX_BACKOFF, GET_MAX_BACKOFF, INGEST_BACKOFF, PD_INFO_BACKOFF, RAWKV_MAX_BACKOFF, SCANNER_NEXT_MAX_BACKOFF, SCATTER_REGION_BACKOFF, seconds, SPLIT_REGION_BACKOFF, TIKV_SWITCH_MODE_BACKOFF, TSO_MAX_BACKOFF

Method Summary

Modifier and Type	Method and Description
boolean	canRetryAfterSleep(BackOffFunction.BackOffFuncType funcType) canRetryAfterSleep sleeps a while base on the BackOffType and records the error message.
boolean	canRetryAfterSleep(BackOffFunction.BackOffFuncType funcType, long maxSleepMs)
void	checkTimeout() check if deadline exceeded.
static ConcreteBackOffer	create(BackOffer source)
void	doBackOff(BackOffFunction.BackOffFuncType funcType, Exception err) doBackOff sleeps a while base on the BackOffType and records the error message.
void	doBackOffWithMaxSleep(BackOffFunction.BackOffFuncType funcType, long maxSleepMs, Exception err) BackoffWithMaxSleep sleeps a while base on the backoffType and records the error message and never sleep more than maxSleepMs for each sleep.
Long	getClusterId()
SlowLog	getSlowLog()
static ConcreteBackOffer	newBatchGetMaxBackOff()
static ConcreteBackOffer	newCopNextMaxBackOff()
static ConcreteBackOffer	newCopNextMaxBackOff(long clusterId)
static ConcreteBackOffer	newCustomBackOff(int maxSleep)
static ConcreteBackOffer	newCustomBackOff(int maxSleep, long clusterId)
static ConcreteBackOffer	newDeadlineBackOff(int timeoutInMs, SlowLog slowLog)
static ConcreteBackOffer	newDeadlineBackOff(int timeoutInMs, SlowLog slowLog, long clusterId)
static ConcreteBackOffer	newGetBackOff(long clusterId)
static ConcreteBackOffer	newRawKVBackOff()
static ConcreteBackOffer	newRawKVBackOff(long clusterId)
static ConcreteBackOffer	newScannerNextMaxBackOff()
static ConcreteBackOffer	newTsoBackOff(long clusterId)

Methods inherited from class java.lang.Object

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

Field Detail

backOffFunctionMap

public final Map<BackOffFunction.BackOffFuncType,BackOffFunction> backOffFunctionMap

errors

public final List<Exception> errors

BACKOFF_DURATION

public static final io.prometheus.client.Histogram BACKOFF_DURATION

Method Detail

newDeadlineBackOff

public static ConcreteBackOffer newDeadlineBackOff(int timeoutInMs,
                                                   SlowLog slowLog,
                                                   long clusterId)

newDeadlineBackOff

public static ConcreteBackOffer newDeadlineBackOff(int timeoutInMs,
                                                   SlowLog slowLog)

newCustomBackOff

public static ConcreteBackOffer newCustomBackOff(int maxSleep,
                                                 long clusterId)

newCustomBackOff

public static ConcreteBackOffer newCustomBackOff(int maxSleep)

newScannerNextMaxBackOff

public static ConcreteBackOffer newScannerNextMaxBackOff()

newBatchGetMaxBackOff

public static ConcreteBackOffer newBatchGetMaxBackOff()

newCopNextMaxBackOff

public static ConcreteBackOffer newCopNextMaxBackOff()

newCopNextMaxBackOff

public static ConcreteBackOffer newCopNextMaxBackOff(long clusterId)

newGetBackOff

public static ConcreteBackOffer newGetBackOff(long clusterId)

newRawKVBackOff

public static ConcreteBackOffer newRawKVBackOff(long clusterId)

newRawKVBackOff

public static ConcreteBackOffer newRawKVBackOff()

newTsoBackOff

public static ConcreteBackOffer newTsoBackOff(long clusterId)

create

public static ConcreteBackOffer create(BackOffer source)

doBackOff

public void doBackOff(BackOffFunction.BackOffFuncType funcType,
                      Exception err)

Description copied from interface: BackOffer

doBackOff sleeps a while base on the BackOffType and records the error message. Will stop until max back off time exceeded and throw an exception to the caller.

Specified by:

doBackOff in interface BackOffer

checkTimeout

public void checkTimeout()

Description copied from interface: BackOffer

check if deadline exceeded.

Specified by:

checkTimeout in interface BackOffer

canRetryAfterSleep

public boolean canRetryAfterSleep(BackOffFunction.BackOffFuncType funcType)

Description copied from interface: BackOffer

canRetryAfterSleep sleeps a while base on the BackOffType and records the error message. Will stop until max back off time exceeded and throw an exception to the caller. It will return false if the total sleep time has exceed some limit condition.

Specified by:

canRetryAfterSleep in interface BackOffer

canRetryAfterSleep

public boolean canRetryAfterSleep(BackOffFunction.BackOffFuncType funcType,
                                  long maxSleepMs)

doBackOffWithMaxSleep

public void doBackOffWithMaxSleep(BackOffFunction.BackOffFuncType funcType,
                                  long maxSleepMs,
                                  Exception err)

Description copied from interface: BackOffer

BackoffWithMaxSleep sleeps a while base on the backoffType and records the error message and never sleep more than maxSleepMs for each sleep.

Specified by:

doBackOffWithMaxSleep in interface BackOffer

getSlowLog

public SlowLog getSlowLog()

Specified by:

getSlowLog in interface BackOffer

getClusterId

public Long getClusterId()

Specified by:

getClusterId in interface BackOffer