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

Interface Timeout

All Known Implementing Classes:

AdaptiveTimeout, ConstantTimeout, ExecutionTimeBasedTimeout, NoTimeout

public interface Timeout

Policy deciding when to stop the execution of a program. Clients can report progress through reportOneStepProgress(). This information may be used by the policy to make a decision. Once the policy decides to end the execution, it will call all handlers registered through registerCallback(Runnable). This will happen asynchronously.

A timeout must be initialised through init() exactly once before it is used.

Method Summary

Modifier and Type	Method and Description
void	init() Initialises the timeout object.
boolean	isReached() Determines whether the timeout is reached.
void	registerCallback(Runnable callback) Registers callback to be run once the timeout is reached.
void	reportOneStepProgress() Reports one step of progress to the policy.
void	unregisterCallback(Runnable callback) Removes callback from the set of callbacks to be run once the timeout is reached.

Method Detail

isReached

boolean isReached()

Determines whether the timeout is reached. Once this method has returned true, it will return true on all further ivocations.

Returns:

true if the timeout is reached; false otherwise.

reportOneStepProgress

void reportOneStepProgress()

Reports one step of progress to the policy. What one step of progress is is to be defined by the client. The timeout may use this information to make its decision.

init

void init()

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

registerCallback

void registerCallback(Runnable callback)

Registers callback to be run once the timeout is reached.

Parameters:

callback - A Runnable object.

unregisterCallback

void unregisterCallback(Runnable callback)

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

Parameters:

callback - A Runnable object.