com.helger.quartz.utils.counter.sampled

Class SampledCounter

java.lang.Object

com.helger.quartz.utils.counter.Counter

com.helger.quartz.utils.counter.sampled.SampledCounter

All Implemented Interfaces:

ICounter, ISampledCounter

Direct Known Subclasses:

SampledRateCounter

public class SampledCounter
extends Counter
implements ISampledCounter

An implementation of ISampledCounter

Since:

1.7

Author:

Abhishek Sanoujam

Field Summary

Fields

Modifier and Type	Field and Description
protected CircularLossyQueue<TimeStampedCounterValue>	m_aHistory The history of this counter
protected boolean	m_bResetOnSample Should the counter reset on each sample?

Constructor Summary

Constructors

Constructor and Description
SampledCounter(SampledCounterConfig config) Constructor accepting a SampledCounterConfig

Method Summary

Modifier and Type	Method and Description
TimeStampedCounterValue[]	getAllSampleValues() Returns all samples in history
long	getAndReset() Returns the current value of the counter and resets it to 0
long	getIntervalMillis()
TimeStampedCounterValue	getMostRecentSample() Returns the most recent sampled value
TimerTask	getTimerTask()
void	shutdown() Shutdown this counter

Methods inherited from class com.helger.quartz.utils.counter.Counter

decrement, getAndSet, getValue, increment, increment, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.quartz.utils.counter.ICounter

decrement, decrement, getAndSet, getValue, increment, increment, setValue

Field Detail

m_aHistory

protected final CircularLossyQueue<TimeStampedCounterValue> m_aHistory

The history of this counter

m_bResetOnSample

protected final boolean m_bResetOnSample

Should the counter reset on each sample?

Constructor Detail

SampledCounter

public SampledCounter(@Nonnull
                      SampledCounterConfig config)

Constructor accepting a SampledCounterConfig

Parameters:

config - config

Method Detail

getMostRecentSample

public TimeStampedCounterValue getMostRecentSample()

Description copied from interface: ISampledCounter

Returns the most recent sampled value

Specified by:

getMostRecentSample in interface ISampledCounter

Returns:

Value of the most recent sampled value

getAllSampleValues

public TimeStampedCounterValue[] getAllSampleValues()

Description copied from interface: ISampledCounter

Returns all samples in history

Specified by:

getAllSampleValues in interface ISampledCounter

Returns:

An array containing the TimeStampedCounterValue's

shutdown

public void shutdown()

Description copied from interface: ISampledCounter

Shutdown this counter

Specified by:

shutdown in interface ISampledCounter

getTimerTask

public TimerTask getTimerTask()

Returns:

the timer task for this sampled counter

getIntervalMillis

public long getIntervalMillis()

Returns:

the sampling thread interval in millis

getAndReset

public long getAndReset()

Description copied from interface: ISampledCounter

Returns the current value of the counter and resets it to 0

Specified by:

getAndReset in interface ISampledCounter

Returns:

current value of the counter