alluxio.grpc

Class GrpcChannel

java.lang.Object

io.grpc.Channel

alluxio.grpc.GrpcChannel

public final class GrpcChannel
extends io.grpc.Channel

An authenticated gRPC channel. This channel can communicate with servers of type GrpcServer.

Constructor Summary

Constructors

Constructor and Description
GrpcChannel(GrpcChannelKey channelKey, AuthenticatedChannel channel, long shutdownTimeoutMs) Create a new instance of GrpcChannel with an authenticated channel.
GrpcChannel(GrpcChannelKey channelKey, io.grpc.Channel channel, long shutdownTimeoutMs) Create a new instance of GrpcChannel.

Method Summary

Modifier and Type	Method and Description
String	authority()
void	intercept(io.grpc.ClientInterceptor interceptor) Intercepts the channel with given interceptor.
boolean	isHealthy()
boolean	isShutdown()
<RequestT,ResponseT> io.grpc.ClientCall<RequestT,ResponseT>	newCall(io.grpc.MethodDescriptor<RequestT,ResponseT> methodDescriptor, io.grpc.CallOptions callOptions)
void	shutdown() Shuts down the channel.
String	toString()
String	toStringShort()

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcChannel

public GrpcChannel(GrpcChannelKey channelKey,
                   io.grpc.Channel channel,
                   long shutdownTimeoutMs)

Create a new instance of GrpcChannel.

Parameters:

channelKey - the channel key

channel - the grpc channel to wrap

shutdownTimeoutMs - shutdown timeout in milliseconds

GrpcChannel

public GrpcChannel(GrpcChannelKey channelKey,
                   AuthenticatedChannel channel,
                   long shutdownTimeoutMs)

Create a new instance of GrpcChannel with an authenticated channel.

Parameters:

channelKey - the channel key

channel - the authenticated grpc channel

shutdownTimeoutMs - shutdown timeout in milliseconds

Method Detail

newCall

public <RequestT,ResponseT> io.grpc.ClientCall<RequestT,ResponseT> newCall(io.grpc.MethodDescriptor<RequestT,ResponseT> methodDescriptor,
                                                                           io.grpc.CallOptions callOptions)

Specified by:

newCall in class io.grpc.Channel

authority

public String authority()

Specified by:

authority in class io.grpc.Channel

intercept

public void intercept(io.grpc.ClientInterceptor interceptor)

Intercepts the channel with given interceptor.

Parameters:

interceptor - interceptor

shutdown

public void shutdown()

Shuts down the channel.

isShutdown

public boolean isShutdown()

Returns:

true if the channel has been shut down

isHealthy

public boolean isHealthy()

Returns:

true if channel is healthy

toString

public String toString()

Overrides:

toString in class Object

toStringShort

public String toStringShort()

Returns:

a short identifier for the channel