tachyon.thrift

Interface WorkerService.Iface

All Known Implementing Classes:

WorkerService.Client, WorkerServiceHandler

Enclosing class:

WorkerService

public static interface WorkerService.Iface

Method Summary

Methods

Modifier and Type	Method and Description
void	accessBlock(long blockId)
void	addCheckpoint(long userId, int fileId)
boolean	asyncCheckpoint(int fileId)
void	cacheBlock(long userId, long blockId) Used to cache a block into Tachyon space, worker will move the temporary block file from user folder to data folder, and update the space usage information related.
void	cancelBlock(long userId, long blockId) Used to cancel a block which is being written.
String	getUserUfsTempFolder(long userId) Used to get user's temporary folder on under file system, and the path of the user's temporary folder will be returned.
String	lockBlock(long blockId, long userId) Lock the file in Tachyon's space while the user is reading it, and the path of the block file locked will be returned, if the block file is not found, FileDoesNotExistException will be thrown.
boolean	promoteBlock(long blockId) Used to promote block on under storage layer to top storage layer when there are more than one storage layers in Tachyon's space.
String	requestBlockLocation(long userId, long blockId, long initialBytes) 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.
boolean	requestSpace(long userId, long blockId, long requestBytes) Used to request space for some block file.
boolean	unlockBlock(long blockId, long userId) Used to unlock a block after the block is accessed, if the block is to be removed, delete the block file.
void	userHeartbeat(long userId) Local user send heartbeat to local worker to keep its temporary folder.

Method Detail

accessBlock

void accessBlock(long blockId)
                 throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

addCheckpoint

void addCheckpoint(long userId,
                 int fileId)
                   throws FileDoesNotExistException,
                          SuspectedFileSizeException,
                          FailedToCheckpointException,
                          BlockInfoException,
                          org.apache.thrift.TException

Throws:

FileDoesNotExistException

SuspectedFileSizeException

FailedToCheckpointException

BlockInfoException

org.apache.thrift.TException

asyncCheckpoint

boolean asyncCheckpoint(int fileId)
                        throws TachyonException,
                               org.apache.thrift.TException

Throws:

TachyonException

org.apache.thrift.TException

cacheBlock

void cacheBlock(long userId,
              long blockId)
                throws FileDoesNotExistException,
                       SuspectedFileSizeException,
                       BlockInfoException,
                       org.apache.thrift.TException

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

Parameters:

userId -

blockId -

Throws:

FileDoesNotExistException

SuspectedFileSizeException

BlockInfoException

org.apache.thrift.TException

cancelBlock

void cancelBlock(long userId,
               long blockId)
                 throws 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:

userId -

blockId -

Throws:

org.apache.thrift.TException

getUserUfsTempFolder

String getUserUfsTempFolder(long userId)
                            throws org.apache.thrift.TException

Used to get user's temporary folder on under file system, and the path of the user's temporary folder will be returned.

Parameters:

userId -

Throws:

org.apache.thrift.TException

lockBlock

String lockBlock(long blockId,
               long userId)
                 throws FileDoesNotExistException,
                        org.apache.thrift.TException

Lock the file in Tachyon's space while the user is reading it, and the path of the block file locked will be returned, if the block file is not found, FileDoesNotExistException will be thrown.

Parameters:

blockId -

userId -

Throws:

FileDoesNotExistException

org.apache.thrift.TException

promoteBlock

boolean promoteBlock(long blockId)
                     throws 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 Tachyon's space. return true if the block is successfully promoted, false otherwise.

Parameters:

blockId -

Throws:

org.apache.thrift.TException

requestBlockLocation

String requestBlockLocation(long userId,
                          long blockId,
                          long initialBytes)
                            throws OutOfSpaceException,
                                   FileAlreadyExistException,
                                   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 Tachyon storage OutOfSpaceException will be thrown, if the file is already being written by the user, FileAlreadyExistException will be thrown.

Parameters:

userId -

blockId -

initialBytes -

Throws:

OutOfSpaceException

FileAlreadyExistException

org.apache.thrift.TException

requestSpace

boolean requestSpace(long userId,
                   long blockId,
                   long requestBytes)
                     throws FileDoesNotExistException,
                            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:

userId -

blockId -

requestBytes -

Throws:

FileDoesNotExistException

org.apache.thrift.TException

unlockBlock

boolean unlockBlock(long blockId,
                  long userId)
                    throws 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 -

userId -

Throws:

org.apache.thrift.TException

userHeartbeat

void userHeartbeat(long userId)
                   throws org.apache.thrift.TException

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

Parameters:

userId -

Throws:

org.apache.thrift.TException