alluxio.client.block.stream

Class GrpcDataMessageBlockingStream<ReqT,ResT>

java.lang.Object

alluxio.client.block.stream.GrpcBlockingStream<ReqT,ResT>

alluxio.client.block.stream.GrpcDataMessageBlockingStream<ReqT,ResT>

Type Parameters:

ReqT - type of the request

ResT - type of the response

@NotThreadSafe
public class GrpcDataMessageBlockingStream<ReqT,ResT>
extends GrpcBlockingStream<ReqT,ResT>

A helper class for accessing gRPC bi-directional stream synchronously.

Constructor Summary

Constructors

Constructor and Description
GrpcDataMessageBlockingStream(java.util.function.Function<io.grpc.stub.StreamObserver<ResT>,io.grpc.stub.StreamObserver<ReqT>> rpcFunc, int bufferSize, String description, DataMessageMarshaller<ReqT> requestMarshaller, DataMessageMarshaller<ResT> responseMarshaller)

Method Summary

Modifier and Type	Method and Description
ResT	receive(long timeoutMs) Receives a response from the server.
DataMessage<ResT,DataBuffer>	receiveDataMessage(long timeoutMs) Receives a response with data buffer from the server.
void	sendDataMessage(DataMessage<ReqT,DataBuffer> message, long timeoutMs) Sends a request.
Optional<ResT>	waitForComplete(long timeoutMs) Wait for server to complete the inbound stream.

Methods inherited from class alluxio.client.block.stream.GrpcBlockingStream

cancel, close, isCanceled, isClosed, isOpen, send, send

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcDataMessageBlockingStream

public GrpcDataMessageBlockingStream(java.util.function.Function<io.grpc.stub.StreamObserver<ResT>,io.grpc.stub.StreamObserver<ReqT>> rpcFunc,
                                     int bufferSize,
                                     String description,
                                     DataMessageMarshaller<ReqT> requestMarshaller,
                                     DataMessageMarshaller<ResT> responseMarshaller)

Parameters:

rpcFunc - the gRPC bi-directional stream stub function

bufferSize - maximum number of incoming messages the buffer can hold

description - description of this stream

requestMarshaller - the marshaller for the request

responseMarshaller - the marshaller for the response

Method Detail

receive

public ResT receive(long timeoutMs)
             throws IOException

Description copied from class: GrpcBlockingStream

Receives a response from the server. Will wait until a response is received, or throw an exception if times out.

Overrides:

receive in class GrpcBlockingStream<ReqT,ResT>

Parameters:

timeoutMs - maximum time to wait before giving up and throwing a DeadlineExceededException

Returns:

the response message, or null if the inbound stream is completed

Throws:

IOException - if any error occurs

receiveDataMessage

public DataMessage<ResT,DataBuffer> receiveDataMessage(long timeoutMs)
                                                throws IOException

Receives a response with data buffer from the server. Will wait until a response is received, or throw an exception if times out. Caller of this method must release the buffer after reading the data.

Parameters:

timeoutMs - maximum time to wait before giving up and throwing a DeadlineExceededException

Returns:

the response message with data buffer, or null if the inbound stream is completed

Throws:

IOException - if any error occurs

sendDataMessage

public void sendDataMessage(DataMessage<ReqT,DataBuffer> message,
                            long timeoutMs)
                     throws IOException

Sends a request. Will wait until the stream is ready before sending or timeout if the given timeout is reached.

Parameters:

message - the request message with attached

timeoutMs - maximum wait time before throwing a DeadlineExceededException

Throws:

IOException - if any error occurs

waitForComplete

public Optional<ResT> waitForComplete(long timeoutMs)
                               throws IOException

Description copied from class: GrpcBlockingStream

Wait for server to complete the inbound stream.

Overrides:

waitForComplete in class GrpcBlockingStream<ReqT,ResT>

Parameters:

timeoutMs - maximum time to wait for server response

Returns:

the last response of the stream

Throws:

IOException