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

Modifier and Type	Class and Description
static class	DefaultBlockWorkerClient.NoDataReadStreamObserver No data read stream observer.

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

BlockWorkerClient.Factory

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultBlockWorkerClient(UserState userState, GrpcServerAddress address, AlluxioConfiguration alluxioConf) Creates a client instance for communicating with block worker.
protected	DefaultBlockWorkerClient(UserState userState, GrpcServerAddress address, AlluxioConfiguration alluxioConf, GrpcChannel streamingChannel, GrpcChannel rpcChannel)

Method Summary

Modifier and Type	Method and Description
void	cache(CacheRequest request) Caches a block.
ClearMetricsResponse	clearMetrics(ClearMetricsRequest request) Clear the worker metrics.
void	close()
CompleteFilePResponse	completeFile(CompleteFilePRequest request) Complete a file when writing is done.
com.google.common.util.concurrent.ListenableFuture<CopyResponse>	copy(CopyRequest request) copy files from src to dst.
CreateDirectoryPResponse	createDirectory(CreateDirectoryPRequest request) Create a directory.
CreateFilePResponse	createFile(CreateFilePRequest request) Create file request from client to worker.
DeletePResponse	delete(DeletePRequest request) Delete a file from.
ExistsPResponse	exists(ExistsPRequest request) Check if a file or dir exists.
void	freeWorker() Free this worker.
GetStatusPResponse	getStatus(GetStatusPRequest request) get file status.
boolean	isHealthy()
boolean	isShutdown()
Iterator<ListStatusPResponse>	listStatus(ListStatusPRequest request) List status from Worker.
com.google.common.util.concurrent.ListenableFuture<LoadResponse>	load(LoadRequest request) load blocks into alluxio.
com.google.common.util.concurrent.ListenableFuture<LoadFileResponse>	loadFile(LoadFileRequest request) load files.
com.google.common.util.concurrent.ListenableFuture<MoveResponse>	move(MoveRequest request) move files from src to dst.
MoveBlockResponse	moveBlock(MoveBlockRequest request) Move a block from worker.
io.grpc.stub.StreamObserver<ReadRequest>	readBlock(io.grpc.stub.StreamObserver<ReadResponse> responseObserver) Reads a block from the worker.
com.google.common.util.concurrent.ListenableFuture<Object>	readBlockNoDataBack(ReadRequest request) Reads a block with getting actual data.
RemoveBlockResponse	removeBlock(RemoveBlockRequest request) Removes a block from worker.
RenamePResponse	rename(RenamePRequest request) Rename the src to dst.
SetAttributePResponse	setAttribute(SetAttributePRequest request) SetAttribute for a file or dir.
io.grpc.stub.StreamObserver<WriteRequest>	writeBlock(io.grpc.stub.StreamObserver<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(UserState userState,
                                GrpcServerAddress address,
                                AlluxioConfiguration alluxioConf)
                         throws IOException

Creates a client instance for communicating with block worker.

Parameters:

userState - the user state

address - the address of the worker

alluxioConf - Alluxio configuration

Throws:

IOException

DefaultBlockWorkerClient

protected DefaultBlockWorkerClient(UserState userState,
                                   GrpcServerAddress address,
                                   AlluxioConfiguration alluxioConf,
                                   GrpcChannel streamingChannel,
                                   GrpcChannel rpcChannel)
                            throws IOException

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<WriteRequest> writeBlock(io.grpc.stub.StreamObserver<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

readBlockNoDataBack

public com.google.common.util.concurrent.ListenableFuture<Object> readBlockNoDataBack(ReadRequest request)

Description copied from interface: BlockWorkerClient

Reads a block with getting actual data.

Specified by:

readBlockNoDataBack in interface BlockWorkerClient

Parameters:

request - the read request

Returns:

the stream observer for the client request

readBlock

public io.grpc.stub.StreamObserver<ReadRequest> readBlock(io.grpc.stub.StreamObserver<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

removeBlock

public RemoveBlockResponse removeBlock(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 MoveBlockResponse moveBlock(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

clearMetrics

public ClearMetricsResponse clearMetrics(ClearMetricsRequest request)

Description copied from interface: BlockWorkerClient

Clear the worker metrics.

Specified by:

clearMetrics in interface BlockWorkerClient

Parameters:

request - the request to clear metrics

Returns:

the response from server

cache

public void cache(CacheRequest request)

Description copied from interface: BlockWorkerClient

Caches a block.

Specified by:

cache in interface BlockWorkerClient

Parameters:

request - the cache request

freeWorker

public void freeWorker()

Description copied from interface: BlockWorkerClient

Free this worker.

Specified by:

freeWorker in interface BlockWorkerClient

load

public com.google.common.util.concurrent.ListenableFuture<LoadResponse> load(LoadRequest request)

Description copied from interface: BlockWorkerClient

load blocks into alluxio.

Specified by:

load in interface BlockWorkerClient

Parameters:

request - the cache request

Returns:

listenable future of LoadResponse

loadFile

public com.google.common.util.concurrent.ListenableFuture<LoadFileResponse> loadFile(LoadFileRequest request)

Description copied from interface: BlockWorkerClient

load files.

Specified by:

loadFile in interface BlockWorkerClient

Returns:

listenable future of LoadFileResponse

getStatus

public GetStatusPResponse getStatus(GetStatusPRequest request)

Description copied from interface: BlockWorkerClient

get file status.

Specified by:

getStatus in interface BlockWorkerClient

Returns:

status

listStatus

public Iterator<ListStatusPResponse> listStatus(ListStatusPRequest request)

Description copied from interface: BlockWorkerClient

List status from Worker.

Specified by:

listStatus in interface BlockWorkerClient

Returns:

List of Status

copy

public com.google.common.util.concurrent.ListenableFuture<CopyResponse> copy(CopyRequest request)

Description copied from interface: BlockWorkerClient

copy files from src to dst.

Specified by:

copy in interface BlockWorkerClient

Parameters:

request - the copy request

Returns:

listenable future of CopyResponse

move

public com.google.common.util.concurrent.ListenableFuture<MoveResponse> move(MoveRequest request)

Description copied from interface: BlockWorkerClient

move files from src to dst.

Specified by:

move in interface BlockWorkerClient

Parameters:

request - the move request

Returns:

listenable future of MoveResponse

createFile

public CreateFilePResponse createFile(CreateFilePRequest request)

Description copied from interface: BlockWorkerClient

Create file request from client to worker.

Specified by:

createFile in interface BlockWorkerClient

Parameters:

request - the request to create a file

Returns:

a response to contain FileInfo and OpenHandle

completeFile

public CompleteFilePResponse completeFile(CompleteFilePRequest request)

Description copied from interface: BlockWorkerClient

Complete a file when writing is done.

Specified by:

completeFile in interface BlockWorkerClient

Parameters:

request - the request to complete a file

Returns:

a response of this operation

delete

public DeletePResponse delete(DeletePRequest request)

Description copied from interface: BlockWorkerClient

Delete a file from.

Specified by:

delete in interface BlockWorkerClient

Parameters:

request - the request to delete a file

Returns:

a response of this operation

rename

public RenamePResponse rename(RenamePRequest request)

Description copied from interface: BlockWorkerClient

Rename the src to dst.

Specified by:

rename in interface BlockWorkerClient

Parameters:

request - the request to do rename

Returns:

a response of this operation

createDirectory

public CreateDirectoryPResponse createDirectory(CreateDirectoryPRequest request)

Description copied from interface: BlockWorkerClient

Create a directory.

Specified by:

createDirectory in interface BlockWorkerClient

Parameters:

request - the request to create a dir

Returns:

a response of this operation

exists

public ExistsPResponse exists(ExistsPRequest request)

Description copied from interface: BlockWorkerClient

Check if a file or dir exists.

Specified by:

exists in interface BlockWorkerClient

Parameters:

request - the request to do the cechking

Returns:

a response of this operation

setAttribute

public SetAttributePResponse setAttribute(SetAttributePRequest request)

Description copied from interface: BlockWorkerClient

SetAttribute for a file or dir.

Specified by:

setAttribute in interface BlockWorkerClient

Parameters:

request - the request to do the operation

Returns:

a response of this operation