org.knopflerfish.util.workerthread

Class RepeatingJob

java.lang.Object

org.knopflerfish.util.workerthread.Job

org.knopflerfish.util.workerthread.RepeatingJob

All Implemented Interfaces:

java.lang.Runnable

public abstract class RepeatingJob
extends Job

Constructor Summary

Constructors

Constructor and Description
RepeatingJob(int[] delays, int repeatPolicy) Creates a repetetive event.

Method Summary

Methods

Modifier and Type	Method and Description
int	getRepeatNo() Returns the number of successful repeats this job has made.
void	quit() This method can be called to stop repeating this Job.

Methods inherited from class org.knopflerfish.util.workerthread.Job

run

Methods inherited from class java.lang.Object

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

Constructor Detail

RepeatingJob

public RepeatingJob(int[] delays,
            int repeatPolicy)

Creates a repetetive event. This Job still needs to be added to an WorkerThread, but after its run has been called the first time, it will add itself after a delay indicated by delays[0]. Subsequent runs will occur as indicated by the array delays. All delays are in milliseconds.

Parameters:

delays - The delays (in milliseconds) to make between the calls to this RepeatingJobs run() method.

repeatPolicy - Indicates what to do when this RepeatingJob has been called as many times as the delays parameter specifies by its length. A positive value will keep on calling the run() method indefinitely, each time using repeatPolicy milliseconds as the delay. A negative value or zero, will cause this event not to be repeated any more.

Method Detail

quit

public void quit()

This method can be called to stop repeating this Job.

getRepeatNo

public int getRepeatNo()

Returns the number of successful repeats this job has made. I.e., the number of times its run() method has been invoked and terminated normally since it was last added to the WorkerThread.