alluxio.client.block.stream

Interface BlockWorkerClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DefaultBlockWorkerClient

public interface BlockWorkerClient
extends Closeable

gRPC client for worker communication.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BlockWorkerClient.Factory Factory for block worker client.

Method Summary

Modifier and Type	Method and Description
void	asyncCache(AsyncCacheRequest request) Caches a block asynchronously.
ClearMetricsResponse	clearMetrics(ClearMetricsRequest request) Clear the worker metrics.
io.grpc.stub.StreamObserver<CreateLocalBlockRequest>	createLocalBlock(io.grpc.stub.StreamObserver<CreateLocalBlockResponse> responseObserver) Creates a local block on the worker.
boolean	isHealthy()
boolean	isShutdown()
MoveBlockResponse	moveBlock(MoveBlockRequest request) Move a block from worker.
io.grpc.stub.StreamObserver<OpenLocalBlockRequest>	openLocalBlock(io.grpc.stub.StreamObserver<OpenLocalBlockResponse> responseObserver) Opens a local block.
io.grpc.stub.StreamObserver<ReadRequest>	readBlock(io.grpc.stub.StreamObserver<ReadResponse> responseObserver) Reads a block from the worker.
RemoveBlockResponse	removeBlock(RemoveBlockRequest request) Removes a block from worker.
io.grpc.stub.StreamObserver<WriteRequest>	writeBlock(io.grpc.stub.StreamObserver<WriteResponse> responseObserver) Writes a block to the worker asynchronously.

Methods inherited from interface java.io.Closeable

close

Method Detail

isShutdown

boolean isShutdown()

Returns:

whether the client is shutdown

isHealthy

boolean isHealthy()

Returns:

whether the client is healthy

writeBlock

io.grpc.stub.StreamObserver<WriteRequest> writeBlock(io.grpc.stub.StreamObserver<WriteResponse> responseObserver)

Writes a block to the worker asynchronously. The caller should pass in a response observer for receiving server responses and handling errors.

Parameters:

responseObserver - the stream observer for the server response

Returns:

the stream observer for the client request

readBlock

io.grpc.stub.StreamObserver<ReadRequest> readBlock(io.grpc.stub.StreamObserver<ReadResponse> responseObserver)

Reads a block from the worker. When client is done with the file, it should close the stream using the gRPC context.

Parameters:

responseObserver - the stream observer for the server response

Returns:

the stream observer for the client request

createLocalBlock

io.grpc.stub.StreamObserver<CreateLocalBlockRequest> createLocalBlock(io.grpc.stub.StreamObserver<CreateLocalBlockResponse> responseObserver)

Creates a local block on the worker. This is a two stage operations: 1. Client sends a create request through the request stream. Server will respond with the name of the file to write to. 2. When client is done with the file, it should signal complete or cancel on the request stream based on the intent. The server will signal complete on the response stream once the operation is done.

Parameters:

responseObserver - the stream observer for the server response

Returns:

the stream observer for the client request

openLocalBlock

io.grpc.stub.StreamObserver<OpenLocalBlockRequest> openLocalBlock(io.grpc.stub.StreamObserver<OpenLocalBlockResponse> responseObserver)

Opens a local block. This is a two stage operations: 1. Client sends a open request through the request stream. Server will respond with the name of the file to read from. 2. When client is done with the file, it should close the stream.

Parameters:

responseObserver - the stream observer for the server response

Returns:

the stream observer for the client request

removeBlock

RemoveBlockResponse removeBlock(RemoveBlockRequest request)

Removes a block from worker.

Parameters:

request - the remove block request

Returns:

the response from server

Throws:

io.grpc.StatusRuntimeException - if any error occurs

moveBlock

MoveBlockResponse moveBlock(MoveBlockRequest request)

Move a block from worker.

Parameters:

request - the remove block request

Returns:

the response from server

Throws:

io.grpc.StatusRuntimeException - if any error occurs

clearMetrics

ClearMetricsResponse clearMetrics(ClearMetricsRequest request)

Clear the worker metrics.

Parameters:

request - the request to clear metrics

Returns:

the response from server

asyncCache

void asyncCache(AsyncCacheRequest request)

Caches a block asynchronously.

Parameters:

request - the async cache request