alluxio

Interface Client

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

BlockMasterClient, FileSystemMasterClient, JobMasterClient, JobMasterClient, MetaMasterClient, MetaMasterConfigClient, TableMasterClient

All Known Implementing Classes:

AbstractClient, AbstractJobMasterClient, AbstractMasterClient, BlockMasterClient, CachingBlockMasterClient, FileSystemMasterClient, FileSystemMasterClient, RaftJournalServiceClient, RetryHandlingBlockMasterClient, RetryHandlingFileSystemMasterClient, RetryHandlingJobMasterClient, RetryHandlingJobMasterClient, RetryHandlingJournalMasterClient, RetryHandlingMetaMasterClient, RetryHandlingMetaMasterConfigClient, RetryHandlingMetaMasterMasterClient, RetryHandlingMetricsMasterClient, RetryHandlingTableMasterClient

public interface Client
extends Closeable

Interface for a client in the Alluxio system.

Method Summary

Modifier and Type	Method and Description
void	connect() Connects with the remote.
void	disconnect() Closes the connection with the Alluxio remote and does the necessary cleanup.
InetSocketAddress	getConfAddress()
String	getRemoteHostName()
SocketAddress	getRemoteSockAddress()
boolean	isClosed()
boolean	isConnected() Returns the connected status of the client.

Methods inherited from interface java.io.Closeable

close

Method Detail

connect

void connect()
      throws IOException

Connects with the remote.

Throws:

IOException

disconnect

void disconnect()

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

getRemoteSockAddress

SocketAddress getRemoteSockAddress()
                            throws UnavailableException

Returns:

the SocketAddress of the remote

Throws:

UnavailableException - if the primary address cannot be determined

getRemoteHostName

String getRemoteHostName()
                  throws UnavailableException

Returns:

the host name of the remote

Throws:

UnavailableException - if the primary address cannot be determined

getConfAddress

InetSocketAddress getConfAddress()
                          throws UnavailableException

Returns:

the InetSocketAddress of the configuration remote

Throws:

UnavailableException - if the primary address cannot be determined

isConnected

boolean isConnected()

Returns the connected status of the client.

Returns:

true if this client is connected to the remote

isClosed

boolean isClosed()

Returns:

whether the client is closed