tachyon

Class ClientBase

java.lang.Object

tachyon.ClientBase

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

MasterClientBase

public abstract class ClientBase
extends Object
implements Closeable

The base class for clients.

Field Summary

Fields

Modifier and Type	Field and Description
protected InetSocketAddress	mAddress
protected boolean	mClosed Is true if this client was closed by the user.
protected boolean	mConnected Is true if this client is currently connected.
protected String	mMode
protected org.apache.thrift.protocol.TProtocol	mProtocol
protected TachyonConf	mTachyonConf
protected static int	RPC_MAX_NUM_RETRY The number of times to retry a particular RPC.

Constructor Summary

Constructors

Constructor and Description
ClientBase(InetSocketAddress address, TachyonConf tachyonConf, String mode) Creates a new client base.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterConnect() This method is called after the connection is made to the remote.
protected void	afterDisconnect() This method is called after the connection is disconnected.
void	close() Closes the connection with the remote permanently.
void	connect() Connects with the remote.
void	disconnect() Closes the connection with the Tachyon remote and do the necessary cleanup.
protected InetSocketAddress	getAddress() Returns the InetSocketAddress of the remote.
protected abstract String	getServiceName() Returns the name of the service.
boolean	isConnected() Returns the connected status of the client.
void	resetConnection() Closes the connection, then query and set current remote address.

Methods inherited from class java.lang.Object

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

Field Detail

RPC_MAX_NUM_RETRY

protected static final int RPC_MAX_NUM_RETRY

The number of times to retry a particular RPC.

See Also:

Constant Field Values

mTachyonConf

protected final TachyonConf mTachyonConf

mMode

protected final String mMode

mAddress

protected InetSocketAddress mAddress

mProtocol

protected org.apache.thrift.protocol.TProtocol mProtocol

mConnected

protected boolean mConnected

Is true if this client is currently connected.

mClosed

protected boolean mClosed

Is true if this client was closed by the user. No further actions are possible after the client is closed.

Constructor Detail

ClientBase

public ClientBase(InetSocketAddress address,
          TachyonConf tachyonConf,
          String mode)

Creates a new client base.

Parameters:

address - the address

tachyonConf - the Tachyon configuration

mode - the mode of the client for display

Method Detail

getServiceName

protected abstract String getServiceName()

Returns the name of the service.

Returns:

A string representing the specific service

afterConnect

protected void afterConnect()

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

afterDisconnect

protected void afterDisconnect()

This method is called after the connection is disconnected. Implementations should clean up any additional state created for the connection.

connect

public void connect()
             throws IOException

Connects with the remote.

Throws:

IOException - if an I/O error occurs

disconnect

public void disconnect()

Closes the connection with the Tachyon remote and do the necessary cleanup. It should be used if the client has not connected with the remote for a while, for example.

isConnected

public boolean isConnected()

Returns the connected status of the client.

Returns:

true if this client is connected to the remote

close

public void close()

Closes the connection with the remote permanently. This instance should be not be reused after closing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

resetConnection

public void resetConnection()

Closes the connection, then query and set current remote address.

getAddress

protected InetSocketAddress getAddress()

Returns the InetSocketAddress of the remote.

Returns:

the InetSocketAddress of the remote