org.apache.reef.wake.time.runtime

Class RuntimeClock

java.lang.Object

org.apache.reef.wake.time.runtime.RuntimeClock

All Implemented Interfaces:

AutoCloseable, Runnable, Clock

public final class RuntimeClock
extends Object
implements Clock

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.reef.wake.time.Clock

Clock.IdleHandler, Clock.RuntimeStartHandler, Clock.RuntimeStopHandler, Clock.StartHandler, Clock.StopHandler

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This will stop the clock after all client alarms finish executing.
boolean	isIdle() Clock is idle if it has no future Alarms set.
void	registerEventHandler(Class<? extends Time> clazz, EventHandler<Time> handler)
void	run()
void	scheduleAlarm(int offset, EventHandler<Alarm> handler) Schedule a TimerEvent at the given future offset
void	scheduleRuntimeAlarm(int offset, EventHandler<Alarm> handler)
void	stop() This stops the clock immediately, without waiting for client alarms to finish.

Methods inherited from class java.lang.Object

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

Method Detail

scheduleAlarm

public final void scheduleAlarm(int offset,
                 EventHandler<Alarm> handler)

Description copied from interface: Clock

Schedule a TimerEvent at the given future offset

Specified by:

scheduleAlarm in interface Clock

Parameters:

offset - into the future

handler - to be called

registerEventHandler

public final void registerEventHandler(Class<? extends Time> clazz,
                        EventHandler<Time> handler)

scheduleRuntimeAlarm

public final void scheduleRuntimeAlarm(int offset,
                        EventHandler<Alarm> handler)

stop

public final void stop()

Description copied from interface: Clock

This stops the clock immediately, without waiting for client alarms to finish.

Specified by:

stop in interface Clock

close

public final void close()

Description copied from interface: Clock

This will stop the clock after all client alarms finish executing.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Clock

isIdle

public final boolean isIdle()

Description copied from interface: Clock

Clock is idle if it has no future Alarms set.

Specified by:

isIdle in interface Clock

Returns:

true if idle, otherwise false

run

public final void run()

Specified by:

run in interface Runnable