com.neeve.util

Class UtlGovernor

java.lang.Object

com.neeve.util.UtlGovernor

public final class UtlGovernor
extends Object

A convenience class for executing a number of operations at a maximum target rate.

By default this class governs rates by busy spinning to keep cpu caches hot, unless nv.conservecpu=false in which case Thread.sleep will be use to conserve cpu. If setWaitStrategy(WaitStrategy) is explicitly set by the creator of the governor then that policy will be used.

This class IS supported for use by end users.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UtlGovernor.WaitStrategy Enumerates the set of wait strategies used by the UtlGovernor in #b

Constructor Summary

Constructors

Constructor and Description
UtlGovernor(int rate) Creates a governer that will busy spin on calls to blockToNext() if the number of prior calls has exceeded the provided rate since the creation of the UtlGoverner.

Method Summary

Modifier and Type	Method and Description
void	blockToNext() Blocks until returning won't exceed this governer's target rate.
UtlGovernor.WaitStrategy	getWaitStrategy() Gets the UtlGovernor.WaitStrategy used by the rate governor.
static void	run(int iterations, int rate, Runnable command) Runs the provided Runnable command for a given number of iterations, attempting to operate at the overall given rate.
void	setWaitStrategy(UtlGovernor.WaitStrategy waitStrategy) Sets the wait strategy used to wait for the next operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

UtlGovernor

public UtlGovernor(int rate)

Creates a governer that will busy spin on calls to blockToNext() if the number of prior calls has exceeded the provided rate since the creation of the UtlGoverner.

Parameters:

rate - The target rate beyond which call to blockToNext() will block.

Method Detail

getWaitStrategy

public final UtlGovernor.WaitStrategy getWaitStrategy()

Gets the UtlGovernor.WaitStrategy used by the rate governor.

Returns:

The wait strategy.

setWaitStrategy

public final void setWaitStrategy(UtlGovernor.WaitStrategy waitStrategy)

Sets the wait strategy used to wait for the next operation.

Parameters:

waitStrategy - The wait strategy.

blockToNext

public final void blockToNext()

Blocks until returning won't exceed this governer's target rate.

run

public static final void run(int iterations,
                             int rate,
                             Runnable command)

Runs the provided Runnable command for a given number of iterations, attempting to operate at the overall given rate.

Parameters:

iterations - The number of interations to execute.

rate - The target rate at which to run the command.

command - The command to run on each iteration.