freenet.support

Class MemoryLimitedJob

java.lang.Object

freenet.support.MemoryLimitedJob

public abstract class MemoryLimitedJob
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected long	initialAllocation

Constructor Summary

Constructors

Constructor and Description
MemoryLimitedJob(long initial)

Method Summary

Modifier and Type	Method and Description
abstract int	getPriority() All memory limited jobs run at LOW_PRIORITY.
abstract boolean	start(MemoryLimitedChunk chunk) Start the job.

Methods inherited from class java.lang.Object

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

Field Detail

initialAllocation

protected final long initialAllocation

Constructor Detail

MemoryLimitedJob

public MemoryLimitedJob(long initial)

Method Detail

getPriority

public abstract int getPriority()

All memory limited jobs run at LOW_PRIORITY. This affects queueing.

start

public abstract boolean start(MemoryLimitedChunk chunk)

Start the job. Generally called by MemoryLimitedJobRunner, which schedules jobs within the limited available resource (memory).

Parameters:

chunk - The chunk of the scarce resource that has been allocated for this job. Can be released but not added to. Initial size is equal to initialAllocation().

Returns:

If this returns true, the caller (MemoryLimitedJobRunner) will call release() on the chunk, and the job must have finished, freeing up all of the memory buffers in use. If it returns false, the job may still be running (asynchronously), and must call MemoryLimitedJobRunner.MemoryLimitedChunk.release() when it is finished.