com.twitter.hbc

Interface RateTracker

All Known Implementing Classes:

BasicRateTracker

public interface RateTracker

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

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

Method Detail

eventObserved

void eventObserved()

pause

void pause()

Pauses the rate tracker: the rate will be frozen.

resume

void resume()

start

void start()

stop

void stop()

Stops tracking the rate

shutdown

void shutdown()

Stops and shuts down the underlying executor

getCurrentRateSeconds

double getCurrentRateSeconds()

Returns:

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