freenet.support

Class PrioritizedTicker

java.lang.Object

freenet.support.PrioritizedTicker

All Implemented Interfaces:

Ticker, java.lang.Runnable

public class PrioritizedTicker
extends java.lang.Object
implements Ticker, java.lang.Runnable

Constructor Summary

Constructors

Constructor and Description
PrioritizedTicker(Executor executor, int portNumber)

Method Summary

Modifier and Type	Method and Description
Executor	getExecutor() Get the underlying Executor.
void	queueTimedJob(java.lang.Runnable job, long offset) Run a job after a given delay.
void	queueTimedJob(java.lang.Runnable runner, java.lang.String name, long offset, boolean runOnTickerAnyway, boolean noDupes) Queue a job at a specific time (offset in milliseconds from "now").
void	queueTimedJobAbsolute(java.lang.Runnable runner, java.lang.String name, long time, boolean runOnTickerAnyway, boolean noDupes) Queue a job at a specific time (absolute time in milliseconds).
void	removeQueuedJob(java.lang.Runnable runnable) Remove a queued job.
void	run()
protected void	sleep(long sleepTime)
void	start()

Methods inherited from class java.lang.Object

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

Constructor Detail

PrioritizedTicker

public PrioritizedTicker(Executor executor,
                         int portNumber)

Method Detail

start

public void start()

run

public void run()

Specified by:

run in interface java.lang.Runnable

sleep

protected void sleep(long sleepTime)
              throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

queueTimedJob

public void queueTimedJob(java.lang.Runnable job,
                          long offset)

Description copied from interface: Ticker

Run a job after a given delay.

Specified by:

queueTimedJob in interface Ticker

Parameters:

job - The Runnable to execute.

offset - The delay in milliseconds.

queueTimedJob

public void queueTimedJob(java.lang.Runnable runner,
                          java.lang.String name,
                          long offset,
                          boolean runOnTickerAnyway,
                          boolean noDupes)

Queue a job at a specific time (offset in milliseconds from "now").

Specified by:

queueTimedJob in interface Ticker

Parameters:

runner - The job to run. FastRunnable's get run directly on the PacketSender thread.

name - The name of the job, the thread running it will temporarily take this name, assuming it is run on a separate thread.

offset - The time at which to run the job in milliseconds after System.currentTimeMillis().

runOnTickerAnyway - If false, run jobs with offset <=0 on the ticker, to preserve their thread priorities; if true, jobs to run immediately through the executor (which normally will also preserve thread priorities, but may need to call back via runOnTickerAnyway=true if it needs to increase the thread priority).

noDupes - Don't run this job if it is already scheduled. Relatively expensive, O(n) with queued jobs. Necessary for Announcer to ensure that we don't get exponentially increasing numbers of announcement check jobs queued, while ensuring that we do always have one queued within the given period.

queueTimedJobAbsolute

public void queueTimedJobAbsolute(java.lang.Runnable runner,
                                  java.lang.String name,
                                  long time,
                                  boolean runOnTickerAnyway,
                                  boolean noDupes)

Queue a job at a specific time (absolute time in milliseconds). If the time given has passed already, then run the job ASAP.

Specified by:

queueTimedJobAbsolute in interface Ticker

Parameters:

time - The time at which to run the job. @see System.currentTimeMillis()

name - The name of the thread to run it.

runOnTickerAnyway - If true, start the job from the Ticker thread even if we could pass it directly through to the Executor. This is needed for increasing thread priorities, since the Ticker runs at a high priority, and for some tests.

noDupes - If true, ignore the job if it is already queued. Implies runOnTickerAnyway. WARNING: This does not guarantee that we don't run multiple copies of the job simultaneously! You must ensure adequate locking. Worse, if the job takes an unexpectedly long time, you could end up with many copies of the job running simultaneously.

getExecutor

public Executor getExecutor()

Description copied from interface: Ticker

Get the underlying Executor.

Specified by:

getExecutor in interface Ticker

removeQueuedJob

public void removeQueuedJob(java.lang.Runnable runnable)

Description copied from interface: Ticker

Remove a queued job.

Specified by:

removeQueuedJob in interface Ticker