net.imglib2.cache.iotiming

Class IoTimeBudget

java.lang.Object

net.imglib2.cache.iotiming.IoTimeBudget

public class IoTimeBudget
extends Object

Budget of time that can be spent in blocking IO. The budget is grouped by priority levels, where level 0 is the highest priority. The budget for level i > j must always be smaller-equal the budget for level j. For BDV, the time unit of IoTimeBudget values is nanoseconds.

Constructor Summary

Constructors

Constructor and Description
IoTimeBudget()

Method Summary

Modifier and Type	Method and Description
void	clear() Set the budget to 0 (for all levels).
long	estimateTimeLeft(int level) Returns how much time is left for the specified priority level.
void	reset(long[] partialBudget) (Re-)initialize the IO time budget, that is, the time that can be spent in blocking IO.
long	timeLeft(int level) Returns how much time is left for the specified priority level.
void	use(long t, int level) Use the specified amount of time of the specified level.

Methods inherited from class java.lang.Object

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

Constructor Detail

IoTimeBudget

public IoTimeBudget()

Method Detail

reset

public void reset(long[] partialBudget)

(Re-)initialize the IO time budget, that is, the time that can be spent in blocking IO.

Parameters:

partialBudget - Initial budget for priority levels 0 through n. The budget for level i>j must always be smaller-equal the budget for level j.

clear

public void clear()

Set the budget to 0 (for all levels).

timeLeft

public long timeLeft(int level)

Returns how much time is left for the specified priority level.

Parameters:

level - priority level. must be greater ≥ 0.

Returns:

time left for the specified priority level.

use

public void use(long t,
                int level)

Use the specified amount of time of the specified level. t is subtracted from the budgets of level level and smaller. If by this, the remaining budget of level becomes smaller than the remaining budget of level + 1, then this is reduced too. (And the same for higher levels.)

Parameters:

t - how much time to use.

level - priority level. must be greater ≥ 0.

estimateTimeLeft

public long estimateTimeLeft(int level)

Returns how much time is left for the specified priority level.

Parameters:

level - priority level. must be greater ≥ 0.

Returns:

time left for the specified priority level.