com.google.cloud.bigtable.grpc.async

Class RetryingStreamOperation<RequestT,ResponseT>

java.lang.Object

io.grpc.ClientCall.Listener<ResponseT>

com.google.cloud.bigtable.grpc.async.AbstractRetryingOperation<RequestT,ResponseT,List<ResponseT>>

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

@InternalApi(value="For internal usage only")
public class RetryingStreamOperation<RequestT,ResponseT>
extends AbstractRetryingOperation<RequestT,ResponseT,List<ResponseT>>

An extension of AbstractRetryingOperation that aggregates all responses from a streaming request into a List.

For internal use only - public for technical reasons.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.cloud.bigtable.grpc.async.AbstractRetryingOperation

AbstractRetryingOperation.GrpcFuture<RespT>

Field Summary

Fields inherited from class com.google.cloud.bigtable.grpc.async.AbstractRetryingOperation

callWrapper, completionFuture, failedCount, LOG, operationSpan, operationTimerContext, retryExecutorService, retryOptions, rpc, rpcTimerContext, UNARY_DEADLINE_MINUTES

Constructor Summary

Constructors

Constructor and Description
RetryingStreamOperation(RetryOptions retryOptions, RequestT request, BigtableAsyncRpc<RequestT,ResponseT> retryableRpc, io.grpc.CallOptions callOptions, ScheduledExecutorService executorService, io.grpc.Metadata metadata, com.google.api.core.ApiClock clock) Constructor for RetryingCollectingClientCallListener.

Method Summary

Modifier and Type	Method and Description
void	onMessage(ResponseT message)
protected boolean	onOK(io.grpc.Metadata trailers) 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(Object, io.grpc.ClientCall.Listener, Metadata, ClientCall) } with this as the listener so that retries happen correctly.

Methods inherited from class com.google.cloud.bigtable.grpc.async.AbstractRetryingOperation

cancel, cancel, createCallController, finalizeStats, getAsyncResult, getBlockingResult, getExhaustedRetriesException, getNextBackoff, getOperationCallOptions, getRetryRequest, getRpcCallOptions, getRunnable, inRetryMode, isRequestRetryable, isStreamingRead, onClose, onError, performRetry, resetStatusBasedBackoff, setException

Methods inherited from class io.grpc.ClientCall.Listener

onHeaders, onReady

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryingStreamOperation

public RetryingStreamOperation(RetryOptions retryOptions,
                               RequestT request,
                               BigtableAsyncRpc<RequestT,ResponseT> retryableRpc,
                               io.grpc.CallOptions callOptions,
                               ScheduledExecutorService executorService,
                               io.grpc.Metadata metadata,
                               com.google.api.core.ApiClock clock)

Constructor for RetryingCollectingClientCallListener.

Parameters:

retryOptions - a RetryOptions object.

request - a RequestT object.

retryableRpc - a BigtableAsyncRpc object.

callOptions - a CallOptions object.

executorService - a ScheduledExecutorService object.

metadata - a Metadata object.

clock - a ApiClock object

Method Detail

run

public void run()

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

Overrides:

run in class AbstractRetryingOperation<RequestT,ResponseT,List<ResponseT>>

onMessage

public void onMessage(ResponseT message)

Overrides:

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

onOK

protected boolean onOK(io.grpc.Metadata trailers)

A subclass has the opportunity to perform the final operations it needs now that the RPC is successfully complete. If a subclass has to retry, due to the message, this method will return false

Specified by:

onOK in class AbstractRetryingOperation<RequestT,ResponseT,List<ResponseT>>

Returns:

true if the operation was really completed.