com.twitter.hbc

Class BasicRateTracker

java.lang.Object

com.twitter.hbc.BasicRateTracker

All Implemented Interfaces:

RateTracker

public class BasicRateTracker
extends Object
implements RateTracker

Tracks the rate of a recurring event with a sliding window. Threadsafe

Constructor Summary

Constructors

Constructor and Description
BasicRateTracker(int granularityMillis, int numBuckets, boolean startPaused, ScheduledExecutorService executor)

Method Summary

Methods

Modifier and Type	Method and Description
void	eventObserved()
double	getCurrentRateSeconds()
void	pause() Pauses the rate tracker: the rate will be frozen.
void	resume()
void	shutdown() Stops and shuts down the underlying executor
void	start()
void	stop() Stops tracking the rate

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicRateTracker

public BasicRateTracker(int granularityMillis,
                int numBuckets,
                boolean startPaused,
                ScheduledExecutorService executor)

Method Detail

eventObserved

public void eventObserved()

Specified by:

eventObserved in interface RateTracker

pause

public void pause()

Pauses the rate tracker: the rate will be frozen.

Specified by:

pause in interface RateTracker

resume

public void resume()

Specified by:

resume in interface RateTracker

start

public void start()

Specified by:

start in interface RateTracker

stop

public void stop()

Stops tracking the rate

Specified by:

stop in interface RateTracker

shutdown

public void shutdown()

Stops and shuts down the underlying executor

Specified by:

shutdown in interface RateTracker

getCurrentRateSeconds

public double getCurrentRateSeconds()

Specified by:

getCurrentRateSeconds in interface RateTracker

Returns:

the current rate if it is available, NaN if not. The rate is unavailable if granularityMillis hasn't elapsed