com.ibm.etcd.client

Class GrpcClient

java.lang.Object

com.ibm.etcd.client.GrpcClient

public class GrpcClient
extends Object

grpc client support - non-etcd specific

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GrpcClient.AuthProvider
static interface	GrpcClient.ResilientResponseObserver<ReqT,RespT>
static interface	GrpcClient.RetryDecision<ReqT>

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.util.concurrent.RateLimiter	immediateRetryLimiter
protected Condition	isEventThread
protected boolean	sendViaEventLoop
protected com.google.common.util.concurrent.ListeningScheduledExecutorService	ses
protected Executor	userExecutor

Constructor Summary

Constructors

Constructor and Description
GrpcClient(io.grpc.ManagedChannel channel, GrpcClient.AuthProvider authProvider, ScheduledExecutorService executor, Condition isEventThread, Executor userExecutor, boolean sendViaEventLoop, long defaultTimeoutMs)
GrpcClient(io.grpc.ManagedChannel channel, com.google.common.base.Predicate<Throwable> reauthRequired, Supplier<io.grpc.CallCredentials> credsSupplier, ScheduledExecutorService executor, Condition isEventThread, Executor userExecutor, boolean sendViaEventLoop, long defaultTimeoutMs) Deprecated. use other constructor

Method Summary

Modifier and Type	Method and Description
void	authenticateNow()
<ReqT,R> com.google.common.util.concurrent.ListenableFuture<R>	call(io.grpc.MethodDescriptor<ReqT,R> method, Condition precondition, ReqT request, Executor executor, GrpcClient.RetryDecision<ReqT> retry, boolean backoff, io.grpc.Deadline deadline, long timeoutMs)
<ReqT,R> com.google.common.util.concurrent.ListenableFuture<R>	call(io.grpc.MethodDescriptor<ReqT,R> method, ReqT request, boolean idempotent)
<ReqT,R> com.google.common.util.concurrent.ListenableFuture<R>	call(io.grpc.MethodDescriptor<ReqT,R> method, ReqT request, boolean idempotent, long timeoutMillis, Executor executor)
<ReqT,RespT> io.grpc.stub.StreamObserver<ReqT>	callStream(io.grpc.MethodDescriptor<ReqT,RespT> method, GrpcClient.ResilientResponseObserver<ReqT,RespT> respStream)
<ReqT,RespT> io.grpc.stub.StreamObserver<ReqT>	callStream(io.grpc.MethodDescriptor<ReqT,RespT> method, GrpcClient.ResilientResponseObserver<ReqT,RespT> respStream, Executor responseExecutor)
static boolean	causedBy(Throwable t, Class<? extends Throwable> exClass)
protected static void	closeStream(io.grpc.stub.StreamObserver<?> stream, Throwable err)
static io.grpc.Status.Code	codeFromThrowable(Throwable t)
protected static <T> com.google.common.base.Predicate<T>	constantPredicate(boolean val)
protected static boolean	contains(String str, String subStr)
protected static <ReqT> io.grpc.stub.StreamObserver<ReqT>	emptyStream()
protected static <T> com.google.common.util.concurrent.ListenableFuture<T>	failInExecutor(Throwable t, Executor executor)
protected <ReqT,R> com.google.common.util.concurrent.ListenableFuture<R>	fuCall(io.grpc.MethodDescriptor<ReqT,R> method, ReqT request, io.grpc.CallOptions callOptions)
protected <ReqT,R> com.google.common.util.concurrent.ListenableFuture<R>	fuCall(io.grpc.MethodDescriptor<ReqT,R> method, ReqT request, io.grpc.CallOptions callOptions, long timeoutMs)
protected io.grpc.CallOptions	getCallOptions()
ScheduledExecutorService	getExecutor() Deprecated. use getInternalExecutor()
ScheduledExecutorService	getInternalExecutor() Care should be taken not to use this executor for any blocking or CPU intensive tasks.
Executor	getResponseExecutor()
static boolean	isConnectException(Throwable t)
protected boolean	reauthIfRequired(Throwable error, io.grpc.CallOptions callOpts)
protected boolean	retryableStreamError(Throwable error)
static <R> GrpcClient.RetryDecision<R>	retryDecision(boolean idempotent)
static <I> I	sentinel(Class<I> intface)
static Executor	serialized(Executor parent)
static Executor	serialized(Executor parent, int bufferSize)
static <T> T	waitFor(Function<Executor,Future<T>> asyncCall)
static <T> T	waitFor(Function<Executor,Future<T>> asyncCall, Executor fallbackExecutor)
static <T> T	waitFor(Future<T> fut)
static <T> T	waitFor(Future<T> fut, long timeoutMillis)
<T> T	waitForCall(Function<Executor,Future<T>> asyncCall)

Methods inherited from class java.lang.Object

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

Field Detail

ses

protected final com.google.common.util.concurrent.ListeningScheduledExecutorService ses

userExecutor

protected final Executor userExecutor

isEventThread

protected final Condition isEventThread

sendViaEventLoop

protected final boolean sendViaEventLoop

immediateRetryLimiter

protected final com.google.common.util.concurrent.RateLimiter immediateRetryLimiter

Constructor Detail

GrpcClient

@Deprecated
public GrpcClient(io.grpc.ManagedChannel channel,
                              com.google.common.base.Predicate<Throwable> reauthRequired,
                              Supplier<io.grpc.CallCredentials> credsSupplier,
                              ScheduledExecutorService executor,
                              Condition isEventThread,
                              Executor userExecutor,
                              boolean sendViaEventLoop,
                              long defaultTimeoutMs)

Deprecated. use other constructor

GrpcClient

public GrpcClient(io.grpc.ManagedChannel channel,
                  GrpcClient.AuthProvider authProvider,
                  ScheduledExecutorService executor,
                  Condition isEventThread,
                  Executor userExecutor,
                  boolean sendViaEventLoop,
                  long defaultTimeoutMs)

Method Detail

getExecutor

@Deprecated
public ScheduledExecutorService getExecutor()

Deprecated. use getInternalExecutor()

getInternalExecutor

public ScheduledExecutorService getInternalExecutor()

Care should be taken not to use this executor for any blocking or CPU intensive tasks.

getResponseExecutor

public Executor getResponseExecutor()

authenticateNow

public void authenticateNow()

getCallOptions

protected io.grpc.CallOptions getCallOptions()

retryDecision

public static <R> GrpcClient.RetryDecision<R> retryDecision(boolean idempotent)

call

public <ReqT,R> com.google.common.util.concurrent.ListenableFuture<R> call(io.grpc.MethodDescriptor<ReqT,R> method,
                                                                           ReqT request,
                                                                           boolean idempotent)

call

public <ReqT,R> com.google.common.util.concurrent.ListenableFuture<R> call(io.grpc.MethodDescriptor<ReqT,R> method,
                                                                           ReqT request,
                                                                           boolean idempotent,
                                                                           long timeoutMillis,
                                                                           Executor executor)

call

public <ReqT,R> com.google.common.util.concurrent.ListenableFuture<R> call(io.grpc.MethodDescriptor<ReqT,R> method,
                                                                           Condition precondition,
                                                                           ReqT request,
                                                                           Executor executor,
                                                                           GrpcClient.RetryDecision<ReqT> retry,
                                                                           boolean backoff,
                                                                           io.grpc.Deadline deadline,
                                                                           long timeoutMs)

failInExecutor

protected static <T> com.google.common.util.concurrent.ListenableFuture<T> failInExecutor(Throwable t,
                                                                                          Executor executor)

fuCall

protected <ReqT,R> com.google.common.util.concurrent.ListenableFuture<R> fuCall(io.grpc.MethodDescriptor<ReqT,R> method,
                                                                                ReqT request,
                                                                                io.grpc.CallOptions callOptions,
                                                                                long timeoutMs)

fuCall

protected <ReqT,R> com.google.common.util.concurrent.ListenableFuture<R> fuCall(io.grpc.MethodDescriptor<ReqT,R> method,
                                                                                ReqT request,
                                                                                io.grpc.CallOptions callOptions)

retryableStreamError

protected boolean retryableStreamError(Throwable error)

reauthIfRequired

protected boolean reauthIfRequired(Throwable error,
                                   io.grpc.CallOptions callOpts)

Returns:

true if reauthentication was required and attempted

isConnectException

public static boolean isConnectException(Throwable t)

codeFromThrowable

public static io.grpc.Status.Code codeFromThrowable(Throwable t)

callStream

public <ReqT,RespT> io.grpc.stub.StreamObserver<ReqT> callStream(io.grpc.MethodDescriptor<ReqT,RespT> method,
                                                                 GrpcClient.ResilientResponseObserver<ReqT,RespT> respStream)

callStream

public <ReqT,RespT> io.grpc.stub.StreamObserver<ReqT> callStream(io.grpc.MethodDescriptor<ReqT,RespT> method,
                                                                 GrpcClient.ResilientResponseObserver<ReqT,RespT> respStream,
                                                                 Executor responseExecutor)

waitForCall

public final <T> T waitForCall(Function<Executor,Future<T>> asyncCall)

waitFor

public static <T> T waitFor(Future<T> fut)

waitFor

public static <T> T waitFor(Future<T> fut,
                            long timeoutMillis)

waitFor

public static <T> T waitFor(Function<Executor,Future<T>> asyncCall)

waitFor

public static <T> T waitFor(Function<Executor,Future<T>> asyncCall,
                            Executor fallbackExecutor)

closeStream

protected static void closeStream(io.grpc.stub.StreamObserver<?> stream,
                                  Throwable err)

emptyStream

protected static <ReqT> io.grpc.stub.StreamObserver<ReqT> emptyStream()

constantPredicate

protected static <T> com.google.common.base.Predicate<T> constantPredicate(boolean val)

contains

protected static boolean contains(String str,
                                  String subStr)

causedBy

public static boolean causedBy(Throwable t,
                               Class<? extends Throwable> exClass)

sentinel

public static <I> I sentinel(Class<I> intface)

serialized

public static Executor serialized(Executor parent)

serialized

public static Executor serialized(Executor parent,
                                  int bufferSize)