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

Default implementation of clock. After invoking `RuntimeStart` and `StartTime` events initially, this invokes scheduled events on time. If there is no scheduled event, `IdleClock` event is invoked.

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() Wait for all client alarms to finish executing and gracefully shutdown the clock.
boolean	isClosed() The clock is closed after a call to stop() or close().
boolean	isIdle() Check if there are no client alarms scheduled.
void	run() Main event loop.
Time	scheduleAlarm(int offset, EventHandler<Alarm> handler) Schedule a new Alarm event in `offset` milliseconds into the future, and supply an event handler to be called at that time.
void	stop() Stop the clock.
void	stop(Throwable exception) Stop the clock on exception.

Methods inherited from class java.lang.Object

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

Method Detail

scheduleAlarm

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

Schedule a new Alarm event in `offset` milliseconds into the future, and supply an event handler to be called at that time.

Specified by:

scheduleAlarm in interface Clock

Parameters:

offset - Number of milliseconds into the future relative to current time.

handler - Event handler to be invoked.

Returns:

Newly scheduled alarm.

Throws:

IllegalStateException - if the clock is already closed.

stop

public void stop()

Stop the clock. Remove all other events from the schedule and fire StopTimer event immediately. It is recommended to use close() method for graceful shutdown instead of stop().

Specified by:

stop in interface Clock

stop

public void stop(Throwable exception)

Stop the clock on exception. Remove all other events from the schedule and fire StopTimer event immediately.

Specified by:

stop in interface Clock

Parameters:

exception - Exception that is the cause for the stop. Can be null.

close

public void close()

Wait for all client alarms to finish executing and gracefully shutdown the clock.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Clock

isIdle

public boolean isIdle()

Check if there are no client alarms scheduled.

Specified by:

isIdle in interface Clock

Returns:

True if there are no client alarms in the schedule, false otherwise.

isClosed

public boolean isClosed()

The clock is closed after a call to stop() or close(). A closed clock cannot add new alarms to the schedule, but, in case of the graceful shutdown, can still invoke previously scheduled ones.

Specified by:

isClosed in interface Clock

Returns:

true if closed, false otherwise.

run

public void run()

Main event loop. Set up the event handlers, and go into event loop that polls the schedule and process events in it.

Specified by:

run in interface Runnable