alluxio.worker.block

Class BlockWorkerClientServiceHandler

java.lang.Object

alluxio.worker.block.BlockWorkerClientServiceHandler

All Implemented Interfaces:

AlluxioService.Iface, BlockWorkerClientService.Iface

@NotThreadSafe
public final class BlockWorkerClientServiceHandler
extends Object
implements BlockWorkerClientService.Iface

This class is a Thrift handler for block worker RPCs invoked by an Alluxio client. These RPCs are no longer supported as of 1.5.0. All methods will throw UnsupportedOperationException.

Constructor Summary

Constructors

Constructor and Description
BlockWorkerClientServiceHandler(BlockWorker worker) Creates a new instance of BlockWorkerClientServiceHandler.

Method Summary

Modifier and Type	Method and Description
AccessBlockTResponse	accessBlock(long blockId, AccessBlockTOptions options) Accesses a block given the block id.
CacheBlockTResponse	cacheBlock(long sessionId, long blockId, CacheBlockTOptions options) Used to cache a block into Alluxio space, worker will move the temporary block file from session folder to data folder, and update the space usage information related.
CancelBlockTResponse	cancelBlock(long sessionId, long blockId, CancelBlockTOptions options) Used to cancel a block which is being written.
GetServiceVersionTResponse	getServiceVersion(GetServiceVersionTOptions options) Returns the version of the master service.
LockBlockTResponse	lockBlock(long blockId, long sessionId, LockBlockTOptions options) Locks the file in Alluxio's space while the session is reading it.
PromoteBlockTResponse	promoteBlock(long blockId, PromoteBlockTOptions options) Used to promote block on under storage layer to top storage layer when there are more than one storage layers in Alluxio's space.
RemoveBlockTResponse	removeBlock(long blockId, RemoveBlockTOptions options) Used to remove a block from an Alluxio worker.
RequestBlockLocationTResponse	requestBlockLocation(long sessionId, long blockId, long initialBytes, int writeTier, RequestBlockLocationTOptions options) Used to allocate location and space for a new coming block, worker will choose the appropriate storage directory which fits the initial block size by some allocation strategy, and the temporary file path of the block file will be returned.
RequestSpaceTResponse	requestSpace(long sessionId, long blockId, long requestBytes, RequestSpaceTOptions options) Used to request space for some block file.
SessionBlockHeartbeatTResponse	sessionBlockHeartbeat(long sessionId, List<Long> metrics, SessionBlockHeartbeatTOptions options) Local session send heartbeat to local worker to keep its temporary folder.
UnlockBlockTResponse	unlockBlock(long blockId, long sessionId, UnlockBlockTOptions options) Used to unlock a block after the block is accessed, if the block is to be removed, delete the block file.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockWorkerClientServiceHandler

public BlockWorkerClientServiceHandler(BlockWorker worker)

Creates a new instance of BlockWorkerClientServiceHandler.

Parameters:

worker - block worker handler

Method Detail

getServiceVersion

public GetServiceVersionTResponse getServiceVersion(GetServiceVersionTOptions options)

Description copied from interface: AlluxioService.Iface

Returns the version of the master service. NOTE: The version should be updated every time a backwards incompatible API change occurs.

Specified by:

getServiceVersion in interface AlluxioService.Iface

Parameters:

options - the method options

accessBlock

public AccessBlockTResponse accessBlock(long blockId,
                                        AccessBlockTOptions options)
                                 throws AlluxioTException

Description copied from interface: BlockWorkerClientService.Iface

Accesses a block given the block id.

Specified by:

accessBlock in interface BlockWorkerClientService.Iface

Parameters:

blockId - the id of the block being accessed

options - the method options

Throws:

AlluxioTException

cacheBlock

public CacheBlockTResponse cacheBlock(long sessionId,
                                      long blockId,
                                      CacheBlockTOptions options)
                               throws AlluxioTException

Description copied from interface: BlockWorkerClientService.Iface

Used to cache a block into Alluxio space, worker will move the temporary block file from session folder to data folder, and update the space usage information related. then update the block information to master.

Specified by:

cacheBlock in interface BlockWorkerClientService.Iface

Parameters:

sessionId - the id of the current session

blockId - the id of the block being accessed

options - the method options

Throws:

AlluxioTException

cancelBlock

public CancelBlockTResponse cancelBlock(long sessionId,
                                        long blockId,
                                        CancelBlockTOptions options)
                                 throws AlluxioTException

Description copied from interface: BlockWorkerClientService.Iface

Used to cancel a block which is being written. worker will delete the temporary block file and the location and space information related, then reclaim space allocated to the block.

Specified by:

cancelBlock in interface BlockWorkerClientService.Iface

Parameters:

sessionId - the id of the current session

blockId - the id of the block being accessed

options - the method options

Throws:

AlluxioTException

lockBlock

public LockBlockTResponse lockBlock(long blockId,
                                    long sessionId,
                                    LockBlockTOptions options)
                             throws AlluxioTException

Description copied from interface: BlockWorkerClientService.Iface

Locks the file in Alluxio's space while the session is reading it. If lock succeeds, the path of the block's file along with the internal lock id of locked block will be returned. If the block's file is not found, FileDoesNotExistException will be thrown.

Specified by:

lockBlock in interface BlockWorkerClientService.Iface

Parameters:

blockId - the id of the block being accessed

sessionId - the id of the current session

options - the lock method options

Throws:

AlluxioTException

promoteBlock

public PromoteBlockTResponse promoteBlock(long blockId,
                                          PromoteBlockTOptions options)
                                   throws AlluxioTException

Description copied from interface: BlockWorkerClientService.Iface

Used to promote block on under storage layer to top storage layer when there are more than one storage layers in Alluxio's space. return true if the block is successfully promoted, false otherwise.

Specified by:

promoteBlock in interface BlockWorkerClientService.Iface

Parameters:

blockId - the id of the block being accessed

options - the method options

Throws:

AlluxioTException

removeBlock

public RemoveBlockTResponse removeBlock(long blockId,
                                        RemoveBlockTOptions options)
                                 throws AlluxioTException

Description copied from interface: BlockWorkerClientService.Iface

Used to remove a block from an Alluxio worker.

Specified by:

removeBlock in interface BlockWorkerClientService.Iface

Parameters:

blockId - the id of the block being removed

options - the method options

Throws:

AlluxioTException

requestBlockLocation

public RequestBlockLocationTResponse requestBlockLocation(long sessionId,
                                                          long blockId,
                                                          long initialBytes,
                                                          int writeTier,
                                                          RequestBlockLocationTOptions options)
                                                   throws AlluxioTException

Description copied from interface: BlockWorkerClientService.Iface

Used to allocate location and space for a new coming block, worker will choose the appropriate storage directory which fits the initial block size by some allocation strategy, and the temporary file path of the block file will be returned. if there is no enough space on Alluxio storage OutOfSpaceException will be thrown, if the file is already being written by the session, FileAlreadyExistsException will be thrown.

Specified by:

requestBlockLocation in interface BlockWorkerClientService.Iface

Parameters:

sessionId - the id of the current session

blockId - the id of the block being accessed

initialBytes - initial number of bytes requested

writeTier - the target tier to write to

options - the method options

Throws:

AlluxioTException

requestSpace

public RequestSpaceTResponse requestSpace(long sessionId,
                                          long blockId,
                                          long requestBytes,
                                          RequestSpaceTOptions options)
                                   throws AlluxioTException

Description copied from interface: BlockWorkerClientService.Iface

Used to request space for some block file. return true if the worker successfully allocates space for the block on block’s location, false if there is no enough space, if there is no information of the block on worker, FileDoesNotExistException will be thrown.

Specified by:

requestSpace in interface BlockWorkerClientService.Iface

Parameters:

sessionId - the id of the current session

blockId - the id of the block being accessed

requestBytes - the number of bytes requested

options - the method options

Throws:

AlluxioTException

sessionBlockHeartbeat

public SessionBlockHeartbeatTResponse sessionBlockHeartbeat(long sessionId,
                                                            List<Long> metrics,
                                                            SessionBlockHeartbeatTOptions options)
                                                     throws AlluxioTException

Description copied from interface: BlockWorkerClientService.Iface

Local session send heartbeat to local worker to keep its temporary folder.

Specified by:

sessionBlockHeartbeat in interface BlockWorkerClientService.Iface

Parameters:

sessionId - the id of the current session

metrics - deprecated since 1.3.0 and will be removed in 2.0

options - the method options

Throws:

AlluxioTException

unlockBlock

public UnlockBlockTResponse unlockBlock(long blockId,
                                        long sessionId,
                                        UnlockBlockTOptions options)
                                 throws AlluxioTException

Description copied from interface: BlockWorkerClientService.Iface

Used to unlock a block after the block is accessed, if the block is to be removed, delete the block file. return true if successfully unlock the block, return false if the block is not found or failed to delete the block.

Specified by:

unlockBlock in interface BlockWorkerClientService.Iface

Parameters:

blockId - the id of the block being accessed

sessionId - the id of the current session

options - the method options

Throws:

AlluxioTException