alma.acs.concurrent

Class ThreadLoopRunner.CancelableRunnable

java.lang.Object

alma.acs.concurrent.ThreadLoopRunner.CancelableRunnable

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

AlarmsMap.AlarmsMapRunnable, BlobberWorker

Enclosing class:

ThreadLoopRunner

public abstract static class ThreadLoopRunner.CancelableRunnable
extends java.lang.Object
implements java.lang.Runnable

Variation of Runnable that allows other threads to give a hint to the {Runnable.run() method that it should terminate. This is useful mainly with implementations of run() that don't finish immediately. Note that in Java Thread.stop() and similar methods are deprecated, and that the proper way to terminate asynchronously running code is to signal the termination request via some variable that the thread is supposed to check at convenient points.

Therefore if your run method takes non-negligible time, you should

1. provide a subclass of this CancelableRunnable as the loop action in ThreadLoopRunner#ThreadLoopRunner(ThreadFactory, Runnable, Logger)
2. implement run() to check at some points whether the flag shouldTerminate has been set (e.g. by ThreadLoopRunner.shutdown(long, java.util.concurrent.TimeUnit) calling cancel()), and if so, to return from the run method as quickly as possible, but yet cleaning up.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	shouldTerminate

Constructor Summary

Constructors

Constructor and Description
CancelableRunnable()

Method Summary

Modifier and Type	Method and Description
void	cancel() Either the subclass's run() method evaluates the "shouldTerminate" flag, or the cancel() method gets overridden so that the subclass can react directly to it.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

shouldTerminate

protected volatile boolean shouldTerminate

Constructor Detail

CancelableRunnable

public CancelableRunnable()

Method Detail

cancel

public void cancel()

Either the subclass's run() method evaluates the "shouldTerminate" flag, or the cancel() method gets overridden so that the subclass can react directly to it.