com.ausregistry.jtoolkit2.session

Class CommandCounter

java.lang.Object

com.ausregistry.jtoolkit2.session.CommandCounter

public class CommandCounter
extends java.lang.Object

Keep track of how many commands of each type have been processed recently. Instances of this class provide no synchronization. If multiple threads access an instance concurrently, they must provide their own synchronization. Specifically, concurrent invocations of increment may exhibit unexpected behaviour.

Constructor Summary

Constructors

Constructor and Description
CommandCounter() Construct a command counter using the default reset interval.
CommandCounter(long resetInterval) Construct a command counter which ages command processing records out based on the given reset interval (in milliseconds).

Method Summary

Modifier and Type	Method and Description
long	getCount(CommandType type) Get the total number of commands of the given type recorded by this counter.
int	getExactRecentTotal() Get the total number of commands processed recently.
int	getRecentCount(CommandType type) Get the number of commands of the given type processed recently (within the reset interval from now).
int	getRecentTotal() Get an approximation of the total number of commands processed recently.
long	getTotal() Get the total number of commands of all types recorded by this counter.
void	increment(CommandType type) Increment the count of commands of the given type processed recently.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandCounter

public CommandCounter()

Construct a command counter using the default reset interval.

CommandCounter

public CommandCounter(long resetInterval)

Construct a command counter which ages command processing records out based on the given reset interval (in milliseconds).

Parameters:

resetInterval - the interval of time over which counts are taken.

Method Detail

increment

public void increment(CommandType type)

Increment the count of commands of the given type processed recently.

Parameters:

type - the type of command being processed.

getRecentCount

public int getRecentCount(CommandType type)

Get the number of commands of the given type processed recently (within the reset interval from now).

getCount

public long getCount(CommandType type)

Get the total number of commands of the given type recorded by this counter.

getTotal

public long getTotal()

Get the total number of commands of all types recorded by this counter.

getRecentTotal

public int getRecentTotal()

Get an approximation of the total number of commands processed recently. This is actually an upper bound on the actual number of commands processed recently, as the underlying per-command type lists are not necessarily up-to-date. For the exact number, but at significantly greater cost in execution time, use getExactTotal.

getExactRecentTotal

public int getExactRecentTotal()

Get the total number of commands processed recently. This first cleans up the underlying per-command type lists to guarantee that only recent commands are counted in the total.