alluxio.master.transport

Class GrpcMessagingConnection

java.lang.Object

alluxio.master.transport.GrpcMessagingConnection

All Implemented Interfaces:

io.grpc.stub.StreamObserver<TransportMessage>

Direct Known Subclasses:

GrpcMessagingClientConnection, GrpcMessagingServerConnection

public abstract class GrpcMessagingConnection
extends Object
implements io.grpc.stub.StreamObserver<TransportMessage>

Abstract GrpcMessagingConnection implementation based on Alluxio gRPC messaging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GrpcMessagingConnection.ConnectionOwner Defines the owner of connection.
protected static class	GrpcMessagingConnection.ContextualFuture<T> A future with catalyst thread context.
protected static class	GrpcMessagingConnection.HandlerHolder Holds message handler and catalyst thread context.

Constructor Summary

Constructors

Constructor and Description
GrpcMessagingConnection(GrpcMessagingConnection.ConnectionOwner connectionOwner, String transportId, GrpcMessagingContext context, ExecutorService executor, long requestTimeoutMs) Creates a connection object.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	close() Closes the connection.
<T,U> GrpcMessagingConnection	handler(Class<T> type, java.util.function.Consumer<T> handler) Registers a new message handler.
<T,U> GrpcMessagingConnection	handler(Class<T> type, java.util.function.Function<T,CompletableFuture<U>> handler) Registers a new message handler.
protected void	handleResponseMessage(TransportMessage response)
Listener<GrpcMessagingConnection>	onClose(java.util.function.Consumer<GrpcMessagingConnection> listener) Adds a close listener.
void	onCompleted()
void	onError(Throwable t)
Listener<Throwable>	onException(java.util.function.Consumer<Throwable> listener) Adds an exception listener.
void	onNext(TransportMessage message)
CompletableFuture<Void>	send(Object request) Sends a request.
<T,U> CompletableFuture<U>	sendAndReceive(T request) Sends a request and receives a response.
void	setTargetObserver(io.grpc.stub.StreamObserver<TransportMessage> targetObserver) Sets the stream observer for target.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcMessagingConnection

public GrpcMessagingConnection(GrpcMessagingConnection.ConnectionOwner connectionOwner,
                               String transportId,
                               GrpcMessagingContext context,
                               ExecutorService executor,
                               long requestTimeoutMs)

Creates a connection object. Note: setTargetObserver(io.grpc.stub.StreamObserver<alluxio.grpc.TransportMessage>) should be called explicitly before using the connection.

Parameters:

connectionOwner - owner of connection

transportId - transport level Id

context - catalyst thread context

executor - transport executor

requestTimeoutMs - timeout in milliseconds for requests

Method Detail

setTargetObserver

public void setTargetObserver(io.grpc.stub.StreamObserver<TransportMessage> targetObserver)

Sets the stream observer for target.

Parameters:

targetObserver - target's stream observer

send

public CompletableFuture<Void> send(Object request)

Sends a request.

Parameters:

request - the request to send

Returns:

the send request completable future

sendAndReceive

public <T,U> CompletableFuture<U> sendAndReceive(T request)

Sends a request and receives a response.

Type Parameters:

T - Request type

U - Response type

Parameters:

request - the request to send

Returns:

future for results

handler

public <T,U> GrpcMessagingConnection handler(Class<T> type,
                                             java.util.function.Consumer<T> handler)

Registers a new message handler.

Type Parameters:

T - the class and handler type

U - the result type

Parameters:

type - type of the handler

handler - the actual handler to register

Returns:

connection

handler

public <T,U> GrpcMessagingConnection handler(Class<T> type,
                                             java.util.function.Function<T,CompletableFuture<U>> handler)

Registers a new message handler.

Type Parameters:

T - the class and handler type

U - the result type

Parameters:

type - type of the handler

handler - the actual handler to register

Returns:

connection

handleResponseMessage

protected void handleResponseMessage(TransportMessage response)

onException

public Listener<Throwable> onException(java.util.function.Consumer<Throwable> listener)

Adds an exception listener.

Parameters:

listener - the listener to add

Returns:

the listener holder

onClose

public Listener<GrpcMessagingConnection> onClose(java.util.function.Consumer<GrpcMessagingConnection> listener)

Adds a close listener.

Parameters:

listener - the listener to add

Returns:

the listener holder

close

public CompletableFuture<Void> close()

Closes the connection.

Returns:

future of close results

onNext

public void onNext(TransportMessage message)

Specified by:

onNext in interface io.grpc.stub.StreamObserver<TransportMessage>

onError

public void onError(Throwable t)

Specified by:

onError in interface io.grpc.stub.StreamObserver<TransportMessage>

onCompleted

public void onCompleted()

Specified by:

onCompleted in interface io.grpc.stub.StreamObserver<TransportMessage>

toString

public String toString()

Overrides:

toString in class Object