alluxio.worker.file

Class FileSystemMasterClient

java.lang.Object

alluxio.AbstractClient

alluxio.AbstractMasterClient

alluxio.worker.file.FileSystemMasterClient

All Implemented Interfaces:

Client, Closeable, AutoCloseable

@ThreadSafe
public final class FileSystemMasterClient
extends AbstractMasterClient

A wrapper for the gRPC client to interact with the file system master, used by Alluxio worker.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.AbstractClient

AbstractClient.RpcCallable<V>

Field Summary

Fields inherited from class alluxio.AbstractClient

mAddress, mChannel, mClosed, mConfAddress, mConnected, mContext, mServiceVersion, mVersionService

Constructor Summary

Constructors

Constructor and Description
FileSystemMasterClient(MasterClientContext conf) Creates a instance of FileSystemMasterClient.

Method Summary

Modifier and Type	Method and Description
protected void	afterConnect() This method is called after the connection is made to the remote.
FileInfo	getFileInfo(long fileId)
Set<Long>	getPinList()
protected ServiceType	getRemoteServiceType()
protected String	getServiceName()
protected long	getServiceVersion()
UfsInfo	getUfsInfo(long mountId)
FileSystemCommand	heartbeat(long workerId, List<Long> persistedFiles) Heartbeats to the master.
FileSystemCommand	heartbeat(long workerId, List<Long> persistedFiles, FileSystemHeartbeatPOptions options) Heartbeats to the master.

Methods inherited from class alluxio.AbstractMasterClient

getAddress, getConfAddress

Methods inherited from class alluxio.AbstractClient

afterDisconnect, beforeConnect, beforeDisconnect, checkVersion, close, connect, disconnect, getRemoteServiceVersion, isClosed, isConnected, retryRPC, retryRPC

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemMasterClient

public FileSystemMasterClient(MasterClientContext conf)

Creates a instance of FileSystemMasterClient.

Parameters:

conf - master client configuration

Method Detail

getRemoteServiceType

protected ServiceType getRemoteServiceType()

Specified by:

getRemoteServiceType in class AbstractClient

Returns:

the type of remote service

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

getFileInfo

public FileInfo getFileInfo(long fileId)
                     throws IOException

Parameters:

fileId - the id of the file for which to get the FileInfo

Returns:

the file info for the given file id

Throws:

IOException

getPinList

public Set<Long> getPinList()
                     throws IOException

Returns:

the set of pinned file ids

Throws:

IOException

getUfsInfo

public UfsInfo getUfsInfo(long mountId)
                   throws IOException

Parameters:

mountId - the id of the mount

Returns:

the ufs information for the give ufs

Throws:

IOException - if an I/O error occurs

heartbeat

public FileSystemCommand heartbeat(long workerId,
                                   List<Long> persistedFiles)
                            throws IOException

Heartbeats to the master. It also carries command for the worker to persist the given files.

Parameters:

workerId - the id of the worker that heartbeats

persistedFiles - the files which have been persisted since the last heartbeat

Returns:

the command for file system worker

Throws:

IOException

heartbeat

public FileSystemCommand heartbeat(long workerId,
                                   List<Long> persistedFiles,
                                   FileSystemHeartbeatPOptions options)
                            throws IOException

Heartbeats to the master. It also carries command for the worker to persist the given files.

Parameters:

workerId - the id of the worker that heartbeats

persistedFiles - the files which have been persisted since the last heartbeat

options - heartbeat options

Returns:

the command for file system worker

Throws:

IOException