alluxio.heartbeat

Class SleepingTimer

java.lang.Object

alluxio.heartbeat.SleepingTimer

All Implemented Interfaces:

HeartbeatTimer

@NotThreadSafe
public final class SleepingTimer
extends Object
implements HeartbeatTimer

This class can be used for executing heartbeats periodically.

Constructor Summary

Constructors

Constructor and Description
SleepingTimer(String threadName, long intervalMs) Creates a new instance of SleepingTimer.
SleepingTimer(String threadName, long intervalMs, org.slf4j.Logger logger, java.time.Clock clock, Sleeper sleeper) Creates a new instance of SleepingTimer.

Method Summary

Modifier and Type	Method and Description
long	getIntervalMs() Get the interval of HeartbeatTimer.
void	setIntervalMs(long intervalMs) Sets the heartbeat interval.
void	tick() Enforces the thread waits for the given interval between consecutive ticks.

Methods inherited from class java.lang.Object

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

Constructor Detail

SleepingTimer

public SleepingTimer(String threadName,
                     long intervalMs)

Creates a new instance of SleepingTimer.

Parameters:

threadName - the thread name

intervalMs - the heartbeat interval

SleepingTimer

public SleepingTimer(String threadName,
                     long intervalMs,
                     org.slf4j.Logger logger,
                     java.time.Clock clock,
                     Sleeper sleeper)

Creates a new instance of SleepingTimer.

Parameters:

threadName - the thread name

intervalMs - the heartbeat interval

logger - the logger to log to

clock - for telling the current time

sleeper - the utility to use for sleeping

Method Detail

setIntervalMs

public void setIntervalMs(long intervalMs)

Description copied from interface: HeartbeatTimer

Sets the heartbeat interval.

Specified by:

setIntervalMs in interface HeartbeatTimer

Parameters:

intervalMs - the heartbeat interval in ms

getIntervalMs

public long getIntervalMs()

Description copied from interface: HeartbeatTimer

Get the interval of HeartbeatTimer.

Specified by:

getIntervalMs in interface HeartbeatTimer

Returns:

the interval of this HeartbeatTimer

tick

public void tick()
          throws InterruptedException

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

Specified by:

tick in interface HeartbeatTimer

Throws:

InterruptedException - if the thread is interrupted while waiting