de.uka.ipd.sdq.beagle.core.timeout

Class ExecutionTimeBasedTimeout

java.lang.Object

de.uka.ipd.sdq.beagle.core.timeout.ExecutionTimeBasedTimeout

All Implemented Interfaces:

Timeout

Direct Known Subclasses:

AdaptiveTimeout, ConstantTimeout

public abstract class ExecutionTimeBasedTimeout
extends Object
implements Timeout

Abstract class for timeouts deciding when to stop based on the executed program’s run time. Subclasses should always call super.init() when overriding init(). They are also encouraged to check on the initialised flag in all methods.The class furthermore provides functionality to register and unregister callbacks.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Runnable>	callbacks A set of callbacks which will be called once the timeout is reached.
protected boolean	initialised Indicates whether this object has been initialised.
protected long	startingTime The millisecond timestamp indicating when this Timeout object was initialised.

Constructor Summary

Constructors

Constructor and Description
ExecutionTimeBasedTimeout()

Method Summary

Modifier and Type	Method and Description
protected abstract void	implementationInit() For init methods of implementing classes.
void	init() Initialises the timeout object.
void	registerCallback(Runnable callback) Registers callback to be run once the timeout is reached.
void	unregisterCallback(Runnable callback) Removes callback from the set of callbacks to be run once the timeout is reached.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uka.ipd.sdq.beagle.core.timeout.Timeout

isReached, reportOneStepProgress

Field Detail

initialised

protected boolean initialised

Indicates whether this object has been initialised.

startingTime

protected long startingTime

The millisecond timestamp indicating when this Timeout object was initialised.

callbacks

protected final Set<Runnable> callbacks

A set of callbacks which will be called once the timeout is reached.

Constructor Detail

ExecutionTimeBasedTimeout

public ExecutionTimeBasedTimeout()

Method Detail

init

public final void init()

Description copied from interface: Timeout

Initialises the timeout object. This method must be called exactly once before any other method is called.

Specified by:

init in interface Timeout

implementationInit

protected abstract void implementationInit()

For init methods of implementing classes. Runs after init().

registerCallback

public void registerCallback(Runnable callback)

Description copied from interface: Timeout

Registers callback to be run once the timeout is reached.

Specified by:

registerCallback in interface Timeout

Parameters:

callback - A Runnable object.

unregisterCallback

public void unregisterCallback(Runnable callback)

Description copied from interface: Timeout

Removes callback from the set of callbacks to be run once the timeout is reached.

Specified by:

unregisterCallback in interface Timeout

Parameters:

callback - A Runnable object.