alluxio.client.keyvalue

Class KeyValueWorkerClient

java.lang.Object

alluxio.AbstractClient

alluxio.client.keyvalue.KeyValueWorkerClient

All Implemented Interfaces:

Client, Closeable, AutoCloseable

@ThreadSafe
public final class KeyValueWorkerClient
extends AbstractClient

Client for talking to a key-value worker server. Since KeyValueWorkerClientService.Client is not thread safe, this class has to guarantee thread safety.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.AbstractClient

AbstractClient.RpcCallable<V>

Field Summary

Fields inherited from class alluxio.AbstractClient

mAddress, mClosed, mConnected, mProtocol, mServiceVersion

Constructor Summary

Constructors

Constructor and Description
KeyValueWorkerClient(WorkerNetAddress workerNetAddress) Creates a KeyValueWorkerClient.

Method Summary

Modifier and Type	Method and Description
protected void	afterConnect() This method is called after the connection is made to the remote.
ByteBuffer	get(long blockId, ByteBuffer key) Gets the value of a given key from a specific key-value block.
protected AlluxioService.Client	getClient()
List<ByteBuffer>	getNextKeys(long blockId, ByteBuffer key, int numKeys) Gets a batch of keys next to the current key in the partition.
protected String	getServiceName()
protected long	getServiceVersion()
int	getSize(long blockId)

Methods inherited from class alluxio.AbstractClient

afterDisconnect, beforeDisconnect, checkVersion, close, connect, disconnect, getAddress, isConnected, retryRPC, retryRPC

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyValueWorkerClient

public KeyValueWorkerClient(WorkerNetAddress workerNetAddress)

Creates a KeyValueWorkerClient.

Parameters:

workerNetAddress - location of the worker to connect to

Method Detail

getClient

protected AlluxioService.Client getClient()

Specified by:

getClient in class AbstractClient

Returns:

a Thrift service client

getServiceName

protected String getServiceName()

Specified by:

getServiceName in class AbstractClient

Returns:

a string representing the specific service

getServiceVersion

protected long getServiceVersion()

Specified by:

getServiceVersion in class AbstractClient

Returns:

the client service version

afterConnect

protected void afterConnect()
                     throws IOException

Description copied from class: AbstractClient

This method is called after the connection is made to the remote. Implementations should create internal state to finish the connection process.

Overrides:

afterConnect in class AbstractClient

Throws:

IOException

get

public ByteBuffer get(long blockId,
                      ByteBuffer key)
               throws IOException,
                      AlluxioException

Gets the value of a given key from a specific key-value block.

Parameters:

blockId - The id of the block

key - the key to get the value for

Returns:

ByteBuffer of value, or null if not found

Throws:

IOException

AlluxioException

getNextKeys

public List<ByteBuffer> getNextKeys(long blockId,
                                    ByteBuffer key,
                                    int numKeys)
                             throws IOException,
                                    AlluxioException

Gets a batch of keys next to the current key in the partition.

If current key is null, it means get the initial batch of keys. If there are no more next keys, an empty list is returned.

Parameters:

blockId - the id of the partition

key - the current key

numKeys - maximum number of next keys to fetch

Returns:

the next batch of keys

Throws:

IOException

AlluxioException

getSize

public int getSize(long blockId)
            throws IOException,
                   AlluxioException

Parameters:

blockId - the id of the partition

Returns:

the number of key-value pairs in the partition

Throws:

IOException

AlluxioException