alluxio.thrift

Class BlockWorkerClientService.Client

java.lang.Object

org.apache.thrift.TServiceClient

alluxio.thrift.AlluxioService.Client

alluxio.thrift.BlockWorkerClientService.Client

All Implemented Interfaces:

AlluxioService.Iface, BlockWorkerClientService.Iface

Enclosing class:

BlockWorkerClientService

public static class BlockWorkerClientService.Client
extends AlluxioService.Client
implements BlockWorkerClientService.Iface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockWorkerClientService.Client.Factory

Field Summary

Fields inherited from class org.apache.thrift.TServiceClient

iprot_, oprot_, seqid_

Constructor Summary

Constructors

Constructor and Description
Client(org.apache.thrift.protocol.TProtocol prot)
Client(org.apache.thrift.protocol.TProtocol iprot, org.apache.thrift.protocol.TProtocol oprot)

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.
AccessBlockTResponse	recv_accessBlock()
CacheBlockTResponse	recv_cacheBlock()
CancelBlockTResponse	recv_cancelBlock()
LockBlockTResponse	recv_lockBlock()
PromoteBlockTResponse	recv_promoteBlock()
RemoveBlockTResponse	recv_removeBlock()
RequestBlockLocationTResponse	recv_requestBlockLocation()
RequestSpaceTResponse	recv_requestSpace()
SessionBlockHeartbeatTResponse	recv_sessionBlockHeartbeat()
UnlockBlockTResponse	recv_unlockBlock()
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.
void	send_accessBlock(long blockId, AccessBlockTOptions options)
void	send_cacheBlock(long sessionId, long blockId, CacheBlockTOptions options)
void	send_cancelBlock(long sessionId, long blockId, CancelBlockTOptions options)
void	send_lockBlock(long blockId, long sessionId, LockBlockTOptions options)
void	send_promoteBlock(long blockId, PromoteBlockTOptions options)
void	send_removeBlock(long blockId, RemoveBlockTOptions options)
void	send_requestBlockLocation(long sessionId, long blockId, long initialBytes, int writeTier, RequestBlockLocationTOptions options)
void	send_requestSpace(long sessionId, long blockId, long requestBytes, RequestSpaceTOptions options)
void	send_sessionBlockHeartbeat(long sessionId, List<Long> metrics, SessionBlockHeartbeatTOptions options)
void	send_unlockBlock(long blockId, long sessionId, UnlockBlockTOptions options)
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 alluxio.thrift.AlluxioService.Client

getServiceVersion, recv_getServiceVersion, send_getServiceVersion

Methods inherited from class org.apache.thrift.TServiceClient

getInputProtocol, getOutputProtocol, receiveBase, sendBase, sendBaseOneway

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.thrift.AlluxioService.Iface

getServiceVersion

Constructor Detail

Client

public Client(org.apache.thrift.protocol.TProtocol prot)

Client

public Client(org.apache.thrift.protocol.TProtocol iprot,
              org.apache.thrift.protocol.TProtocol oprot)

Method Detail

accessBlock

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

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

org.apache.thrift.TException

send_accessBlock

public void send_accessBlock(long blockId,
                             AccessBlockTOptions options)
                      throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_accessBlock

public AccessBlockTResponse recv_accessBlock()
                                      throws AlluxioTException,
                                             org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

cacheBlock

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

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

org.apache.thrift.TException

send_cacheBlock

public void send_cacheBlock(long sessionId,
                            long blockId,
                            CacheBlockTOptions options)
                     throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_cacheBlock

public CacheBlockTResponse recv_cacheBlock()
                                    throws AlluxioTException,
                                           org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

cancelBlock

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

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

org.apache.thrift.TException

send_cancelBlock

public void send_cancelBlock(long sessionId,
                             long blockId,
                             CancelBlockTOptions options)
                      throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_cancelBlock

public CancelBlockTResponse recv_cancelBlock()
                                      throws AlluxioTException,
                                             org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

lockBlock

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

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

org.apache.thrift.TException

send_lockBlock

public void send_lockBlock(long blockId,
                           long sessionId,
                           LockBlockTOptions options)
                    throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_lockBlock

public LockBlockTResponse recv_lockBlock()
                                  throws AlluxioTException,
                                         org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

promoteBlock

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

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

org.apache.thrift.TException

send_promoteBlock

public void send_promoteBlock(long blockId,
                              PromoteBlockTOptions options)
                       throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_promoteBlock

public PromoteBlockTResponse recv_promoteBlock()
                                        throws AlluxioTException,
                                               org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

removeBlock

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

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

org.apache.thrift.TException

send_removeBlock

public void send_removeBlock(long blockId,
                             RemoveBlockTOptions options)
                      throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_removeBlock

public RemoveBlockTResponse recv_removeBlock()
                                      throws AlluxioTException,
                                             org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

requestBlockLocation

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

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

org.apache.thrift.TException

send_requestBlockLocation

public void send_requestBlockLocation(long sessionId,
                                      long blockId,
                                      long initialBytes,
                                      int writeTier,
                                      RequestBlockLocationTOptions options)
                               throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_requestBlockLocation

public RequestBlockLocationTResponse recv_requestBlockLocation()
                                                        throws AlluxioTException,
                                                               org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

requestSpace

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

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

org.apache.thrift.TException

send_requestSpace

public void send_requestSpace(long sessionId,
                              long blockId,
                              long requestBytes,
                              RequestSpaceTOptions options)
                       throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_requestSpace

public RequestSpaceTResponse recv_requestSpace()
                                        throws AlluxioTException,
                                               org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

sessionBlockHeartbeat

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

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

org.apache.thrift.TException

send_sessionBlockHeartbeat

public void send_sessionBlockHeartbeat(long sessionId,
                                       List<Long> metrics,
                                       SessionBlockHeartbeatTOptions options)
                                throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_sessionBlockHeartbeat

public SessionBlockHeartbeatTResponse recv_sessionBlockHeartbeat()
                                                          throws AlluxioTException,
                                                                 org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

unlockBlock

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

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

org.apache.thrift.TException

send_unlockBlock

public void send_unlockBlock(long blockId,
                             long sessionId,
                             UnlockBlockTOptions options)
                      throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_unlockBlock

public UnlockBlockTResponse recv_unlockBlock()
                                      throws AlluxioTException,
                                             org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException