alluxio.hub.common

Class RpcClient<T extends io.grpc.stub.AbstractBlockingStub<T>>

java.lang.Object

alluxio.hub.common.RpcClient<T>

Type Parameters:

T - the type of client to expose

All Implemented Interfaces:

AutoCloseable

public class RpcClient<T extends io.grpc.stub.AbstractBlockingStub<T>>
extends Object
implements AutoCloseable

A wrapper around a particular client to a gRPC service that will automatically create and connect a channel to the desired endpoint. After creating this class, typical usage will be RpcClient c = new RpcClient(conf, address, service::newBlockingStub) c.get().makeRpc(argument) The class tracks the underlying channel and if it becomes closed or unhealthy will automatically create and connect with a new one.

Constructor Summary

Constructors

Constructor and Description
RpcClient(AlluxioConfiguration conf, InetSocketAddress connectAddress, java.util.function.Function<io.grpc.Channel,T> channelFactory, java.util.function.Supplier<RetryPolicy> policySupplier) Create a new instance of the RpcClient.

Method Summary

Modifier and Type	Method and Description
void	close()
static GrpcChannel	createChannel(InetSocketAddress addr, AlluxioConfiguration conf) Creates a gRPC channel that uses NOSASL for security authentication type.
T	get() Create if necessary a new client if necessary, then return the client.
InetSocketAddress	getAddress()

Methods inherited from class java.lang.Object

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

Constructor Detail

RpcClient

public RpcClient(AlluxioConfiguration conf,
                 InetSocketAddress connectAddress,
                 java.util.function.Function<io.grpc.Channel,T> channelFactory,
                 java.util.function.Supplier<RetryPolicy> policySupplier)

Create a new instance of the RpcClient.

Parameters:

conf - the configuration used to make the connection

connectAddress - the address to connect to

channelFactory - the factory method used create a new gRPC client around the channel

policySupplier - the a supplier of policies to use when attempting to create new channels

Method Detail

createChannel

public static GrpcChannel createChannel(InetSocketAddress addr,
                                        AlluxioConfiguration conf)
                                 throws AlluxioStatusException

Creates a gRPC channel that uses NOSASL for security authentication type.

Parameters:

addr - the address to connect to

conf - the configuration used to make the connection

Returns:

new instance of GrpcChannel

Throws:

AlluxioStatusException

get

public T get()
      throws AlluxioStatusException

Create if necessary a new client if necessary, then return the client.

Returns:

the currently connected client

Throws:

AlluxioStatusException - if a connection to the endpoint can't be made

getAddress

public InetSocketAddress getAddress()

Returns:

the address that this RPC client connects to

close

public void close()

Specified by:

close in interface AutoCloseable