alluxio.heartbeat

Class SleepingTimer

java.lang.Object

alluxio.heartbeat.SleepingTimer

All Implemented Interfaces:

Reconfigurable, HeartbeatTimer

@NotThreadSafe
public class SleepingTimer
extends Object
implements HeartbeatTimer

This class can be used for executing heartbeats periodically.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.time.Clock	mClock
protected SleepIntervalSupplier	mIntervalSupplier
protected java.util.function.Supplier<SleepIntervalSupplier>	mIntervalSupplierSupplier
protected org.slf4j.Logger	mLogger
protected long	mPreviousTickedMs
protected Sleeper	mSleeper

Constructor Summary

Constructors

Constructor and Description
SleepingTimer(String threadName, java.time.Clock clock, java.util.function.Supplier<SleepIntervalSupplier> intervalSupplierSupplier) Creates a new instance of SleepingTimer.
SleepingTimer(String threadName, org.slf4j.Logger logger, java.time.Clock clock, Sleeper sleeper, java.util.function.Supplier<SleepIntervalSupplier> intervalSupplierSupplier) Creates a new instance of SleepingTimer.

Method Summary

Modifier and Type	Method and Description
long	tick() Enforces the thread waits for the given interval between consecutive ticks.
void	update() When this object needs to be reconfigured due to external configuration change etc., this function will be invoked.

Methods inherited from class java.lang.Object

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

Field Detail

mPreviousTickedMs

protected long mPreviousTickedMs

mLogger

protected final org.slf4j.Logger mLogger

mClock

protected final java.time.Clock mClock

mSleeper

protected final Sleeper mSleeper

mIntervalSupplierSupplier

protected final java.util.function.Supplier<SleepIntervalSupplier> mIntervalSupplierSupplier

mIntervalSupplier

protected volatile SleepIntervalSupplier mIntervalSupplier

Constructor Detail

SleepingTimer

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

Creates a new instance of SleepingTimer.

Parameters:

threadName - the thread name

clock - for telling the current time

intervalSupplierSupplier - Sleep time between different heartbeat supplier

SleepingTimer

public SleepingTimer(String threadName,
                     org.slf4j.Logger logger,
                     java.time.Clock clock,
                     Sleeper sleeper,
                     java.util.function.Supplier<SleepIntervalSupplier> intervalSupplierSupplier)

Creates a new instance of SleepingTimer.

Parameters:

threadName - the thread name

logger - the logger to log to

clock - for telling the current time

sleeper - the utility to use for sleeping

intervalSupplierSupplier - Sleep time between different heartbeat supplier

Method Detail

tick

public long tick()
          throws InterruptedException

Enforces the thread waits for the given interval between consecutive ticks.

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

update

public void update()

Description copied from interface: HeartbeatTimer

When this object needs to be reconfigured due to external configuration change etc., this function will be invoked.

Specified by:

update in interface Reconfigurable

Specified by:

update in interface HeartbeatTimer