org.tikv.common.importer

Class ImporterStoreClient<RequestClass,ResponseClass>

java.lang.Object

org.tikv.common.AbstractGRPCClient<ImportSSTGrpc.ImportSSTBlockingStub,ImportSSTGrpc.ImportSSTFutureStub>

org.tikv.common.importer.ImporterStoreClient<RequestClass,ResponseClass>

All Implemented Interfaces:

io.grpc.stub.StreamObserver<ResponseClass>, AutoCloseable

public class ImporterStoreClient<RequestClass,ResponseClass>
extends AbstractGRPCClient<ImportSSTGrpc.ImportSSTBlockingStub,ImportSSTGrpc.ImportSSTFutureStub>
implements io.grpc.stub.StreamObserver<ResponseClass>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImporterStoreClient.ImporterStoreClientBuilder<RequestClass,ResponseClass>

Field Summary

Fields inherited from class org.tikv.common.AbstractGRPCClient

asyncStub, blockingStub, channelFactory, conf, timeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImporterStoreClient(TiConfiguration conf, ChannelFactory channelFactory, ImportSSTGrpc.ImportSSTBlockingStub blockingStub, ImportSSTGrpc.ImportSSTFutureStub asyncStub, ImportSSTGrpc.ImportSSTStub stub)

Method Summary

Modifier and Type	Method and Description
void	close()
void	finishWrite() This API should be called after `writeBatch`.
protected ImportSSTGrpc.ImportSSTFutureStub	getAsyncStub()
protected ImportSSTGrpc.ImportSSTBlockingStub	getBlockingStub()
protected ImportSSTGrpc.ImportSSTStub	getStub()
Throwable	getWriteError()
ResponseClass	getWriteResponse()
boolean	hasWriteResponseError()
boolean	isWriteResponseReceived()
void	multiIngest(Kvrpcpb.Context ctx, Object writeResponse) This API should be called after `finishWrite`.
void	onCompleted()
void	onError(Throwable t)
void	onNext(ResponseClass response)
void	startWrite() Ingest KV pairs to RawKV/Txn using gRPC streaming mode.
void	switchMode(ImportSstpb.SwitchMode mode)
void	writeBatch(RequestClass request) This API should be called after `startWrite`.

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

Constructor Detail

ImporterStoreClient

protected ImporterStoreClient(TiConfiguration conf,
                              ChannelFactory channelFactory,
                              ImportSSTGrpc.ImportSSTBlockingStub blockingStub,
                              ImportSSTGrpc.ImportSSTFutureStub asyncStub,
                              ImportSSTGrpc.ImportSSTStub stub)

Method Detail

isWriteResponseReceived

public boolean isWriteResponseReceived()

getWriteResponse

public ResponseClass getWriteResponse()

hasWriteResponseError

public boolean hasWriteResponseError()

getWriteError

public Throwable getWriteError()

onNext

public void onNext(ResponseClass response)

Specified by:

onNext in interface io.grpc.stub.StreamObserver<ResponseClass>

onError

public void onError(Throwable t)

Specified by:

onError in interface io.grpc.stub.StreamObserver<ResponseClass>

onCompleted

public void onCompleted()

Specified by:

onCompleted in interface io.grpc.stub.StreamObserver<ResponseClass>

startWrite

public void startWrite()

Ingest KV pairs to RawKV/Txn using gRPC streaming mode. This API should be called on both leader and followers.

writeBatch

public void writeBatch(RequestClass request)

This API should be called after `startWrite`.

Parameters:

request -

finishWrite

public void finishWrite()

This API should be called after `writeBatch`.

multiIngest

public void multiIngest(Kvrpcpb.Context ctx,
                        Object writeResponse)
                 throws RegionException

This API should be called after `finishWrite`. This API should be called on leader only.

Parameters:

ctx -

writeResponse -

Throws:

RegionException

switchMode

public void switchMode(ImportSstpb.SwitchMode mode)

getBlockingStub

protected ImportSSTGrpc.ImportSSTBlockingStub getBlockingStub()

Specified by:

getBlockingStub in class AbstractGRPCClient<ImportSSTGrpc.ImportSSTBlockingStub,ImportSSTGrpc.ImportSSTFutureStub>

getAsyncStub

protected ImportSSTGrpc.ImportSSTFutureStub getAsyncStub()

Specified by:

getAsyncStub in class AbstractGRPCClient<ImportSSTGrpc.ImportSSTBlockingStub,ImportSSTGrpc.ImportSSTFutureStub>

getStub

protected ImportSSTGrpc.ImportSSTStub getStub()

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception