alluxio.heartbeat

Class ScheduledTimer

java.lang.Object

alluxio.heartbeat.ScheduledTimer

All Implemented Interfaces:

Reconfigurable, HeartbeatTimer

@ThreadSafe
public final class ScheduledTimer
extends Object
implements HeartbeatTimer

This class can be used for controlling heartbeat execution of threads. In particular, the ScheduledTimer blocks on the tick() method, waiting for someone to invoke the schedule() method. The contract of this class is that the schedule() method should only be called after the tick() was called and that there is exactly one schedule() call per tick() call. The schedule() method is not meant to be invoked directly. Instead, the HeartbeatScheduler class should be used.

Constructor Summary

Constructors

Constructor and Description
ScheduledTimer(String threadName, java.time.Clock clock, java.util.function.Supplier<SleepIntervalSupplier> intervalSupplierSupplier) Creates a new instance of ScheduledTimer.

Method Summary

Modifier and Type	Method and Description
String	getThreadName()
protected void	schedule() Schedules execution of the heartbeat.
long	tick() Waits until next heartbeat should be executed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.heartbeat.HeartbeatTimer

update

Constructor Detail

ScheduledTimer

public ScheduledTimer(String threadName,
                      java.time.Clock clock,
                      java.util.function.Supplier<SleepIntervalSupplier> intervalSupplierSupplier)

Creates a new instance of ScheduledTimer.

Parameters:

threadName - the thread name

clock - for telling the current time (unused)

intervalSupplierSupplier - Sleep time between different heartbeat supplier

Method Detail

getThreadName

public String getThreadName()

Returns:

the thread name

schedule

protected void schedule()

Schedules execution of the heartbeat.

tick

public long tick()
          throws InterruptedException

Description copied from interface: HeartbeatTimer

Waits until next heartbeat should be executed.

Specified by:

tick in interface HeartbeatTimer

Returns:

time limit in milliseconds for this heartbeat action to run for before the next heartbeat is due.

Throws:

InterruptedException - if the thread is interrupted while waiting