alluxio.client.block.stream

Class DefaultBlockWorkerClient

java.lang.Object

alluxio.client.block.stream.DefaultBlockWorkerClient

All Implemented Interfaces:

BlockWorkerClient, Closeable, AutoCloseable

public class DefaultBlockWorkerClient
extends Object
implements BlockWorkerClient

Default implementation of BlockWorkerClient.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.client.block.stream.BlockWorkerClient

BlockWorkerClient.Factory

Constructor Summary

Constructors

Constructor and Description
DefaultBlockWorkerClient(Subject subject, alluxio.grpc.GrpcServerAddress address, alluxio.conf.AlluxioConfiguration alluxioConf, io.netty.channel.EventLoopGroup workerGroup) Creates a client instance for communicating with block worker.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBlockWorkerClient

public DefaultBlockWorkerClient(Subject subject,
                                alluxio.grpc.GrpcServerAddress address,
                                alluxio.conf.AlluxioConfiguration alluxioConf,
                                io.netty.channel.EventLoopGroup workerGroup)
                         throws IOException

Creates a client instance for communicating with block worker.

Parameters:

subject - the user subject, can be null if the user is not available

address - the address of the worker

alluxioConf - Alluxio configuration

workerGroup - The netty EventLoopGroup the channels are will utilize

Throws:

IOException

Method Detail

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BlockWorkerClient

Returns:

whether the client is shutdown

isHealthy

public boolean isHealthy()

Specified by:

isHealthy in interface BlockWorkerClient

Returns:

whether the client is healthy

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

writeBlock

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

Description copied from interface: BlockWorkerClient

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

Specified by:

writeBlock in interface BlockWorkerClient

Parameters:

responseObserver - the stream observer for the server response

Returns:

the stream observer for the client request

readBlock

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

Description copied from interface: BlockWorkerClient

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

Specified by:

readBlock in interface BlockWorkerClient

Parameters:

responseObserver - the stream observer for the server response

Returns:

the stream observer for the client request

createLocalBlock

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

Description copied from interface: BlockWorkerClient

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.

Specified by:

createLocalBlock in interface BlockWorkerClient

Parameters:

responseObserver - the stream observer for the server response

Returns:

the stream observer for the client request

openLocalBlock

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

Description copied from interface: BlockWorkerClient

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.

Specified by:

openLocalBlock in interface BlockWorkerClient

Parameters:

responseObserver - the stream observer for the server response

Returns:

the stream observer for the client request

removeBlock

public alluxio.grpc.RemoveBlockResponse removeBlock(alluxio.grpc.RemoveBlockRequest request)

Description copied from interface: BlockWorkerClient

Removes a block from worker.

Specified by:

removeBlock in interface BlockWorkerClient

Parameters:

request - the remove block request

Returns:

the response from server

moveBlock

public alluxio.grpc.MoveBlockResponse moveBlock(alluxio.grpc.MoveBlockRequest request)

Description copied from interface: BlockWorkerClient

Move a block from worker.

Specified by:

moveBlock in interface BlockWorkerClient

Parameters:

request - the remove block request

Returns:

the response from server

asyncCache

public void asyncCache(alluxio.grpc.AsyncCacheRequest request)

Description copied from interface: BlockWorkerClient

Caches a block asynchronously.

Specified by:

asyncCache in interface BlockWorkerClient

Parameters:

request - the async cache request