alluxio.thrift

Interface BlockWorkerClientService.Iface

All Superinterfaces:

AlluxioService.Iface

All Known Implementing Classes:

BlockWorkerClientService.Client, BlockWorkerClientServiceHandler

Enclosing class:

BlockWorkerClientService

public static interface BlockWorkerClientService.Iface
extends AlluxioService.Iface

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.
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 interface alluxio.thrift.AlluxioService.Iface

getServiceVersion

Method Detail

accessBlock

AccessBlockTResponse accessBlock(long blockId,
                                 AccessBlockTOptions options)
                          throws AlluxioTException,
                                 org.apache.thrift.TException

Accesses a block given the block id.

Parameters:

blockId - the id of the block being accessed

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

cacheBlock

CacheBlockTResponse cacheBlock(long sessionId,
                               long blockId,
                               CacheBlockTOptions options)
                        throws AlluxioTException,
                               org.apache.thrift.TException

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.

Parameters:

sessionId - the id of the current session

blockId - the id of the block being accessed

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

cancelBlock

CancelBlockTResponse cancelBlock(long sessionId,
                                 long blockId,
                                 CancelBlockTOptions options)
                          throws AlluxioTException,
                                 org.apache.thrift.TException

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.

Parameters:

sessionId - the id of the current session

blockId - the id of the block being accessed

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

lockBlock

LockBlockTResponse lockBlock(long blockId,
                             long sessionId,
                             LockBlockTOptions options)
                      throws AlluxioTException,
                             org.apache.thrift.TException

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.

Parameters:

blockId - the id of the block being accessed

sessionId - the id of the current session

options - the lock method options

Throws:

AlluxioTException

org.apache.thrift.TException

promoteBlock

PromoteBlockTResponse promoteBlock(long blockId,
                                   PromoteBlockTOptions options)
                            throws AlluxioTException,
                                   org.apache.thrift.TException

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.

Parameters:

blockId - the id of the block being accessed

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

removeBlock

RemoveBlockTResponse removeBlock(long blockId,
                                 RemoveBlockTOptions options)
                          throws AlluxioTException,
                                 org.apache.thrift.TException

Used to remove a block from an Alluxio worker.

Parameters:

blockId - the id of the block being removed

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

requestBlockLocation

RequestBlockLocationTResponse requestBlockLocation(long sessionId,
                                                   long blockId,
                                                   long initialBytes,
                                                   int writeTier,
                                                   RequestBlockLocationTOptions options)
                                            throws AlluxioTException,
                                                   org.apache.thrift.TException

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.

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

org.apache.thrift.TException

requestSpace

RequestSpaceTResponse requestSpace(long sessionId,
                                   long blockId,
                                   long requestBytes,
                                   RequestSpaceTOptions options)
                            throws AlluxioTException,
                                   org.apache.thrift.TException

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.

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

org.apache.thrift.TException

sessionBlockHeartbeat

SessionBlockHeartbeatTResponse sessionBlockHeartbeat(long sessionId,
                                                     List<Long> metrics,
                                                     SessionBlockHeartbeatTOptions options)
                                              throws AlluxioTException,
                                                     org.apache.thrift.TException

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

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

org.apache.thrift.TException

unlockBlock

UnlockBlockTResponse unlockBlock(long blockId,
                                 long sessionId,
                                 UnlockBlockTOptions options)
                          throws AlluxioTException,
                                 org.apache.thrift.TException

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.

Parameters:

blockId - the id of the block being accessed

sessionId - the id of the current session

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException