alluxio.client.block.stream

Class GrpcBlockingStream<ReqT,ResT>

java.lang.Object

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

Type Parameters:

ReqT - type of the request

ResT - type of the response

Direct Known Subclasses:

GrpcDataMessageBlockingStream

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the stream.
void	close() Closes the outbound stream.
boolean	isCanceled()
boolean	isClosed()
boolean	isOpen()
ResT	receive(long timeoutMs) Receives a response from the server.
void	send(ReqT request) Sends a request.
void	send(ReqT request, long timeoutMs) Sends a request.
Optional<ResT>	waitForComplete(long timeoutMs) Wait for server to complete the inbound stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcBlockingStream

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

Parameters:

rpcFunc - the gRPC bi-directional stream stub function

bufferSize - maximum number of incoming messages the buffer can hold

description - description of this stream

Method Detail

send

public void send(ReqT request,
                 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:

request - the request

timeoutMs - maximum wait time before throwing a DeadlineExceededException

Throws:

IOException - if any error occurs

send

public void send(ReqT request)
          throws IOException

Sends a request. Will not wait for the stream to be ready. If the stream is closed or cancelled this method will return without an error.

Parameters:

request - the request

Throws:

IOException - if any error occurs

receive

public ResT receive(long timeoutMs)
             throws IOException

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

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

close

public void close()

Closes the outbound stream. If the stream is already closed then invoking this method has no effect.

cancel

public void cancel()

Cancels the stream. If the stream is already cancelled then invoking this method has no effect.

waitForComplete

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

Wait for server to complete the inbound stream.

Parameters:

timeoutMs - maximum time to wait for server response

Returns:

the last response of the stream

Throws:

IOException

isOpen

public boolean isOpen()

Returns:

whether the stream is open

isClosed

public boolean isClosed()

Returns:

whether the stream is closed

isCanceled

public boolean isCanceled()

Returns:

whether the stream is canceled