org.tikv.common.region

Class AbstractRegionStoreClient

java.lang.Object

org.tikv.common.AbstractGRPCClient<TikvGrpc.TikvBlockingStub,TikvGrpc.TikvFutureStub>

org.tikv.common.region.AbstractRegionStoreClient

All Implemented Interfaces:

AutoCloseable, RegionErrorReceiver

Direct Known Subclasses:

LockResolverClientV2, LockResolverClientV3, LockResolverClientV4, RegionStoreClient

public abstract class AbstractRegionStoreClient
extends AbstractGRPCClient<TikvGrpc.TikvBlockingStub,TikvGrpc.TikvFutureStub>
implements RegionErrorReceiver

Field Summary

Fields

Modifier and Type	Field and Description
protected RequestKeyCodec	codec
protected TiRegion	region
protected RegionManager	regionManager
static io.prometheus.client.Histogram	SEEK_LEADER_STORE_DURATION
static io.prometheus.client.Histogram	SEEK_PROXY_STORE_DURATION
protected TiStore	store

Fields inherited from class org.tikv.common.AbstractGRPCClient

asyncStub, blockingStub, channelFactory, conf, timeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRegionStoreClient(TiConfiguration conf, TiRegion region, TiStore store, ChannelFactory channelFactory, TikvGrpc.TikvBlockingStub blockingStub, TikvGrpc.TikvFutureStub asyncStub, RegionManager regionManager)

Method Summary

Modifier and Type	Method and Description
void	close()
protected TikvGrpc.TikvFutureStub	getAsyncStub()
protected TikvGrpc.TikvBlockingStub	getBlockingStub()
TiRegion	getRegion()
protected Kvrpcpb.Context	makeContext()
protected Kvrpcpb.Context	makeContext(Metapb.Peer peer)
protected Kvrpcpb.Context	makeContext(Set<Long> resolvedLocks, TiStoreType storeType, SlowLog slowLog)
protected Kvrpcpb.Context	makeContext(TiStoreType storeType, SlowLog slowLog)
boolean	onNotLeader(TiRegion newRegion, BackOffer backOffer) onNotLeader deals with NotLeaderError and returns whether re-splitting key range is needed
boolean	onStoreUnreachable(BackOffer backOffer)

Methods inherited from class org.tikv.common.AbstractGRPCClient

callAsyncWithRetry, callServerStreamingWithRetry, callWithRetry, checkHealth, getConf, getTimeout, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

SEEK_LEADER_STORE_DURATION

public static final io.prometheus.client.Histogram SEEK_LEADER_STORE_DURATION

SEEK_PROXY_STORE_DURATION

public static final io.prometheus.client.Histogram SEEK_PROXY_STORE_DURATION

regionManager

protected final RegionManager regionManager

codec

protected final RequestKeyCodec codec

region

protected TiRegion region

store

protected TiStore store

Constructor Detail

AbstractRegionStoreClient

protected AbstractRegionStoreClient(TiConfiguration conf,
                                    TiRegion region,
                                    TiStore store,
                                    ChannelFactory channelFactory,
                                    TikvGrpc.TikvBlockingStub blockingStub,
                                    TikvGrpc.TikvFutureStub asyncStub,
                                    RegionManager regionManager)

Method Detail

getRegion

public TiRegion getRegion()

Specified by:

getRegion in interface RegionErrorReceiver

getBlockingStub

protected TikvGrpc.TikvBlockingStub getBlockingStub()

Specified by:

getBlockingStub in class AbstractGRPCClient<TikvGrpc.TikvBlockingStub,TikvGrpc.TikvFutureStub>

getAsyncStub

protected TikvGrpc.TikvFutureStub getAsyncStub()

Specified by:

getAsyncStub in class AbstractGRPCClient<TikvGrpc.TikvBlockingStub,TikvGrpc.TikvFutureStub>

close

public void close()
           throws GrpcException

Specified by:

close in interface AutoCloseable

Throws:

GrpcException

onNotLeader

public boolean onNotLeader(TiRegion newRegion,
                           BackOffer backOffer)

onNotLeader deals with NotLeaderError and returns whether re-splitting key range is needed

Specified by:

onNotLeader in interface RegionErrorReceiver

Parameters:

newRegion - the new region presented by NotLeader Error

Returns:

false when re-split is needed.

onStoreUnreachable

public boolean onStoreUnreachable(BackOffer backOffer)

Specified by:

onStoreUnreachable in interface RegionErrorReceiver

makeContext

protected Kvrpcpb.Context makeContext(TiStoreType storeType,
                                      SlowLog slowLog)

makeContext

protected Kvrpcpb.Context makeContext(Set<Long> resolvedLocks,
                                      TiStoreType storeType,
                                      SlowLog slowLog)

makeContext

protected Kvrpcpb.Context makeContext()

makeContext

protected Kvrpcpb.Context makeContext(Metapb.Peer peer)