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	cache(CacheRequest request) Caches a block.
ClearMetricsResponse	clearMetrics(ClearMetricsRequest request) Clear the worker metrics.
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 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

readBlockNoDataBack

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

Reads a block with getting actual data.

Parameters:

request - the read request

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

cache

void cache(CacheRequest request)

Caches a block.

Parameters:

request - the cache request

Throws:

io.grpc.StatusRuntimeException - if any error occurs

freeWorker

void freeWorker()

Free this worker.

load

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

load blocks into alluxio.

Parameters:

request - the cache request

Returns:

listenable future of LoadResponse

Throws:

io.grpc.StatusRuntimeException - if any error occurs

loadFile

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

load files.

Parameters:

request -

Returns:

listenable future of LoadFileResponse

getStatus

GetStatusPResponse getStatus(GetStatusPRequest request)

get file status.

Parameters:

request -

Returns:

status

listStatus

Iterator<ListStatusPResponse> listStatus(ListStatusPRequest request)

List status from Worker.

Parameters:

request -

Returns:

List of Status

copy

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

copy files from src to dst.

Parameters:

request - the copy request

Returns:

listenable future of CopyResponse

Throws:

io.grpc.StatusRuntimeException - if any error occurs

move

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

move files from src to dst.

Parameters:

request - the move request

Returns:

listenable future of MoveResponse

Throws:

io.grpc.StatusRuntimeException - if any error occurs

createFile

CreateFilePResponse createFile(CreateFilePRequest request)

Create file request from client to worker.

Parameters:

request - the request to create a file

Returns:

a response to contain FileInfo and OpenHandle

completeFile

CompleteFilePResponse completeFile(CompleteFilePRequest request)

Complete a file when writing is done.

Parameters:

request - the request to complete a file

Returns:

a response of this operation

delete

DeletePResponse delete(DeletePRequest request)

Delete a file from.

Parameters:

request - the request to delete a file

Returns:

a response of this operation

rename

RenamePResponse rename(RenamePRequest request)

Rename the src to dst.

Parameters:

request - the request to do rename

Returns:

a response of this operation

createDirectory

CreateDirectoryPResponse createDirectory(CreateDirectoryPRequest request)

Create a directory.

Parameters:

request - the request to create a dir

Returns:

a response of this operation

exists

ExistsPResponse exists(ExistsPRequest request)

Check if a file or dir exists.

Parameters:

request - the request to do the cechking

Returns:

a response of this operation

setAttribute

SetAttributePResponse setAttribute(SetAttributePRequest request)

SetAttribute for a file or dir.

Parameters:

request - the request to do the operation

Returns:

a response of this operation