org.voovan.tools.bucket

Class TokenBucket

java.lang.Object

org.voovan.tools.bucket.Bucket

org.voovan.tools.bucket.TokenBucket

public class TokenBucket
extends Bucket

无锁令牌桶

Field Summary

Fields inherited from class org.voovan.tools.bucket.Bucket

BUCKET_HASH_WHEEL_TIMER, hashWheelTask

Constructor Summary

Constructors

Constructor and Description
TokenBucket(int tokenSize, int interval) 令牌桶构造函数
TokenBucket(int tokenSize, int interval, int releaseTime) 令牌桶构造函数

Method Summary

Modifier and Type	Method and Description
boolean	acquire() 获取令牌, 立即返回
void	acquire(int timeout) 获取令牌, 带有时间等待
int	getReleaseTime()
void	init(int tokenSize, int interval, int releaseTime) 令牌桶构造函数
void	setReleaseTime(int releaseTime)

Methods inherited from class org.voovan.tools.bucket.Bucket

getHashWheelTask, release, setHashWheelTask

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenBucket

public TokenBucket(int tokenSize,
                   int interval,
                   int releaseTime)

令牌桶构造函数

Parameters:

tokenSize - 令牌桶默认大小, 每个时间周期新增的量

interval - 令牌桶的新增周期, 每次触发新增一个令牌到令牌桶, 单位: 毫秒

releaseTime - 令牌桶失效并自动移除的时间

TokenBucket

public TokenBucket(int tokenSize,
                   int interval)

令牌桶构造函数

Parameters:

tokenSize - 令牌桶默认大小

interval - 令牌桶的新增周期, 每次触发新增一个令牌到令牌桶, 单位: 毫秒

Method Detail

init

public void init(int tokenSize,
                 int interval,
                 int releaseTime)

令牌桶构造函数

Parameters:

tokenSize - 令牌桶默认大小

interval - 令牌桶的新增周期, 每次触发新增一个令牌到令牌桶, 单位: 毫秒

releaseTime - 令牌存活自动释放时间

getReleaseTime

public int getReleaseTime()

setReleaseTime

public void setReleaseTime(int releaseTime)

acquire

public boolean acquire()

获取令牌, 立即返回

Specified by:

acquire in class Bucket

Returns:

true: 拿到令牌, false: 没有拿到令牌

acquire

public void acquire(int timeout)
             throws TimeoutException

获取令牌, 带有时间等待

Specified by:

acquire in class Bucket

Parameters:

timeout - 等待时间

Throws:

TimeoutException - 超时异常