alluxio.heartbeat

Class HeartbeatThread

java.lang.Object

alluxio.heartbeat.HeartbeatThread

All Implemented Interfaces:

Runnable

@NotThreadSafe
public final class HeartbeatThread
extends Object
implements Runnable

Thread class to execute a heartbeat periodically. This thread is daemonic, so it will not prevent the JVM from exiting.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeartbeatThread.Status Enum representing the status of HeartbeatThread.

Constructor Summary

Constructors

Constructor and Description
HeartbeatThread(String executorName, HeartbeatExecutor executor, java.util.function.Supplier<SleepIntervalSupplier> intervalSupplier, AlluxioConfiguration conf, UserState userState) Convenience method for HeartbeatThread(String, String, HeartbeatExecutor, Supplier, AlluxioConfiguration, UserState, Clock) where threadId is null.
HeartbeatThread(String executorName, HeartbeatExecutor executor, java.util.function.Supplier<SleepIntervalSupplier> intervalSupplier, AlluxioConfiguration conf, UserState userState, java.time.Clock clock) Convenience method for HeartbeatThread(String, String, HeartbeatExecutor, Supplier, AlluxioConfiguration, UserState, Clock) where threadId is null.
HeartbeatThread(String executorName, String threadId, HeartbeatExecutor executor, java.util.function.Supplier<SleepIntervalSupplier> intervalSupplier, AlluxioConfiguration conf, UserState userState, java.time.Clock clock) Creates a Runnable to execute heartbeats for the given HeartbeatExecutor.

Method Summary

Modifier and Type	Method and Description
static String	generateThreadName(String executorName, String threadId)
HeartbeatThread.Status	getStatus()
void	run()

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartbeatThread

public HeartbeatThread(String executorName,
                       String threadId,
                       HeartbeatExecutor executor,
                       java.util.function.Supplier<SleepIntervalSupplier> intervalSupplier,
                       AlluxioConfiguration conf,
                       UserState userState,
                       java.time.Clock clock)

Creates a Runnable to execute heartbeats for the given HeartbeatExecutor. This class is responsible for closing the given HeartbeatExecutor when it finishes.

Parameters:

executorName - identifies the heartbeat thread's executor, should be those defined in HeartbeatContext

threadId - the thread identifier, normally, it is empty, but if a heartbeat executor is started in multiple threads, this can be used to distinguish them, the heartbeat thread's name is a combination of executorName and threadId

executor - identifies the heartbeat thread executor; an instance of a class that implements the HeartbeatExecutor interface

intervalSupplier - Sleep time between different heartbeat supplier

conf - Alluxio configuration

userState - the user state for this heartbeat thread

clock - the clock used to compute the current time

HeartbeatThread

public HeartbeatThread(String executorName,
                       HeartbeatExecutor executor,
                       java.util.function.Supplier<SleepIntervalSupplier> intervalSupplier,
                       AlluxioConfiguration conf,
                       UserState userState)

Convenience method for HeartbeatThread(String, String, HeartbeatExecutor, Supplier, AlluxioConfiguration, UserState, Clock) where threadId is null.

Parameters:

executorName - the executor name that is one of those defined in HeartbeatContext

executor - the heartbeat executor

intervalSupplier - the interval between heartbeats supplier

conf - the Alluxio configuration

userState - the user state for this heartbeat thread

HeartbeatThread

public HeartbeatThread(String executorName,
                       HeartbeatExecutor executor,
                       java.util.function.Supplier<SleepIntervalSupplier> intervalSupplier,
                       AlluxioConfiguration conf,
                       UserState userState,
                       java.time.Clock clock)

Convenience method for HeartbeatThread(String, String, HeartbeatExecutor, Supplier, AlluxioConfiguration, UserState, Clock) where threadId is null.

Parameters:

executorName - the executor name that is one of those defined in HeartbeatContext

executor - the heartbeat executor

intervalSupplier - the interval between heartbeats supplier

conf - the Alluxio configuration

userState - the user state for this heartbeat thread

clock - the clock used to compute the current time

Method Detail

generateThreadName

public static String generateThreadName(String executorName,
                                        String threadId)

Parameters:

executorName - the executor name defined in HeartbeatContext

threadId - the thread identifier

Returns:

the thread name combined of executorName and threadId, if threadId is empty or null, return executorName

run

public void run()

Specified by:

run in interface Runnable

getStatus

public HeartbeatThread.Status getStatus()

Returns:

the status of current heartbeat thread