com.github.lpezet.java.patterns.throttle

Class TokenBucketStrategy

java.lang.Object

com.github.lpezet.java.patterns.throttle.TokenBucketStrategy

All Implemented Interfaces:

IThrottleStrategy

Direct Known Subclasses:

FixedTokenBucketStrategy, LeakyTokenBucketStrategy

public abstract class TokenBucketStrategy
extends Object
implements IThrottleStrategy

Author:

Luc Pezet

Field Summary

Fields

Modifier and Type	Field and Description
protected long	mCapacity
protected long	mNextRefillTime
protected IRefillStrategy	mRefillStrategy
protected long	mTokens

Constructor Summary

Constructors

Constructor and Description
TokenBucketStrategy(long pCapacity, IRefillStrategy pRefillStrategy)

Method Summary

Modifier and Type	Method and Description
long	getCapacity()
long	getCurrentTokens()
long	getNextRefillTime()
long	getRefillIntervalInMillis()
long	getTokens()
boolean	isThrottled()
boolean	isThrottled(long n)
protected abstract void	updateTokens()

Methods inherited from class java.lang.Object

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

Field Detail

mCapacity

protected final long mCapacity

mRefillStrategy

protected final IRefillStrategy mRefillStrategy

mNextRefillTime

protected volatile long mNextRefillTime

mTokens

protected volatile long mTokens

Constructor Detail

TokenBucketStrategy

public TokenBucketStrategy(long pCapacity,
                           IRefillStrategy pRefillStrategy)

Method Detail

getCapacity

public long getCapacity()

getNextRefillTime

public long getNextRefillTime()

Specified by:

getNextRefillTime in interface IThrottleStrategy

getRefillIntervalInMillis

public long getRefillIntervalInMillis()

getTokens

public long getTokens()

isThrottled

public boolean isThrottled()

Specified by:

isThrottled in interface IThrottleStrategy

isThrottled

public boolean isThrottled(long n)

Specified by:

isThrottled in interface IThrottleStrategy

getCurrentTokens

public long getCurrentTokens()

updateTokens

protected abstract void updateTokens()