com.google.cloud.bigtable.grpc.async

Class AbstractRetryingRpcListener<RequestT,ResponseT,ResultT>

java.lang.Object

io.grpc.ClientCall.Listener<ResponseT>

com.google.cloud.bigtable.grpc.async.AbstractRetryingRpcListener<RequestT,ResponseT,ResultT>

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

ReadRowsRetryListener, RetryingCollectingClientCallListener, RetryingUnaryRpcCallListener

public abstract class AbstractRetryingRpcListener<RequestT,ResponseT,ResultT>
extends io.grpc.ClientCall.Listener<ResponseT>
implements Runnable

A AsyncFunction that retries a BigtableAsyncRpc request.

Version:

$Id: $Id

Author:

sduskis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractRetryingRpcListener.GrpcFuture<RespT>

Field Summary

Fields

Modifier and Type	Field and Description
protected io.grpc.ClientCall<RequestT,ResponseT>	call
protected Object	callLock
protected AbstractRetryingRpcListener.GrpcFuture<ResultT>	completionFuture
protected com.google.api.client.util.BackOff	currentBackoff
protected int	failedCount
protected static Logger	LOG Constant LOG
protected ScheduledExecutorService	retryExecutorService
protected RetryOptions	retryOptions
protected BigtableAsyncRpc<RequestT,ResponseT>	rpc
protected Timer.Context	rpcTimerContext

Constructor Summary

Constructors

Constructor and Description
AbstractRetryingRpcListener(RetryOptions retryOptions, RequestT request, BigtableAsyncRpc<RequestT,ResponseT> retryableRpc, io.grpc.CallOptions callOptions, ScheduledExecutorService retryExecutorService, io.grpc.Metadata originalMetadata) Constructor for AbstractRetryingRpcListener.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the RPC.
protected void	cancel(String message) Cancels the RPC with a specific message.
protected AbstractRetryingRpcListener.GrpcFuture<ResultT>	createCompletionFuture()
com.google.common.util.concurrent.ListenableFuture<ResultT>	getCompletionFuture() Getter for the field completionFuture.
protected RequestT	getRetryRequest()
protected boolean	isRequestRetryable()
void	onClose(io.grpc.Status status, io.grpc.Metadata trailers)
protected abstract void	onOK() A subclass has the opportunity to perform the final operations it needs now that the RPC is successfully complete.
void	run() Calls BigtableAsyncRpc.newCall(CallOptions) and BigtableAsyncRpc.start(ClientCall, Object, io.grpc.ClientCall.Listener, Metadata) with this as the listener so that retries happen correctly.
protected void	setException(Exception exception)
void	start() Initial execution of the RPC.

Methods inherited from class io.grpc.ClientCall.Listener

onHeaders, onMessage, onReady

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

Constant LOG

currentBackoff

protected com.google.api.client.util.BackOff currentBackoff

rpc

protected final BigtableAsyncRpc<RequestT,ResponseT> rpc

retryOptions

protected final RetryOptions retryOptions

retryExecutorService

protected final ScheduledExecutorService retryExecutorService

failedCount

protected int failedCount

completionFuture

protected final AbstractRetryingRpcListener.GrpcFuture<ResultT> completionFuture

callLock

protected Object callLock

call

protected io.grpc.ClientCall<RequestT,ResponseT> call

rpcTimerContext

protected Timer.Context rpcTimerContext

Constructor Detail

AbstractRetryingRpcListener

public AbstractRetryingRpcListener(RetryOptions retryOptions,
                                   RequestT request,
                                   BigtableAsyncRpc<RequestT,ResponseT> retryableRpc,
                                   io.grpc.CallOptions callOptions,
                                   ScheduledExecutorService retryExecutorService,
                                   io.grpc.Metadata originalMetadata)

Constructor for AbstractRetryingRpcListener.

Parameters:

retryOptions - a RetryOptions object.

request - a RequestT object.

retryableRpc - a BigtableAsyncRpc object.

callOptions - a CallOptions object.

retryExecutorService - a ScheduledExecutorService object.

originalMetadata - a Metadata object.

Method Detail

createCompletionFuture

protected AbstractRetryingRpcListener.GrpcFuture<ResultT> createCompletionFuture()

onClose

public void onClose(io.grpc.Status status,
                    io.grpc.Metadata trailers)

Overrides:

onClose in class io.grpc.ClientCall.Listener<ResponseT>

isRequestRetryable

protected boolean isRequestRetryable()

setException

protected void setException(Exception exception)

onOK

protected abstract void onOK()

A subclass has the opportunity to perform the final operations it needs now that the RPC is successfully complete.

getCompletionFuture

public com.google.common.util.concurrent.ListenableFuture<ResultT> getCompletionFuture()

Getter for the field completionFuture.

Returns:

a ListenableFuture object.

run

public void run()

Calls BigtableAsyncRpc.newCall(CallOptions) and BigtableAsyncRpc.start(ClientCall, Object, io.grpc.ClientCall.Listener, Metadata) with this as the listener so that retries happen correctly.

Specified by:

run in interface Runnable

getRetryRequest

protected RequestT getRetryRequest()

start

public void start()

Initial execution of the RPC.

cancel

public void cancel()

Cancels the RPC.

cancel

protected void cancel(String message)

Cancels the RPC with a specific message.

Parameters:

message -