パッケージ enkan.throttling

クラス TokenBucket

java.lang.Object

enkan.throttling.TokenBucket

public class TokenBucket
extends java.lang.Object

作成者:

kawasima

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
TokenBucket(long capacity, long initialTokens, RefillStrategy refillStrategy, SleepStrategy sleepStrategy)

メソッドの概要

修飾子とタイプ	メソッド	説明
void	consume()	Consume a single token from the bucket.
void	consume(long numTokens)	Consumes multiple tokens from the bucket.
long	getCapacity()
long	getDurationUntilNextRefill(java.util.concurrent.TimeUnit unit)	Returns the amount of time in the specified time unit until the next group of tokens can be added to the token bucket.
long	getNumTokens()
void	refill(long numTokens)	Refills the bucket with the specified number of tokens.
boolean	tryConsume()	Attempt to consume a single token from the bucket.
boolean	tryConsume(long numTokens)	Attempt to consume a specified number of tokens from the bucket.

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

TokenBucket

public TokenBucket(long capacity,
                   long initialTokens,
                   RefillStrategy refillStrategy,
                   SleepStrategy sleepStrategy)

メソッドの詳細

getCapacity

public long getCapacity()

getNumTokens

public long getNumTokens()

getDurationUntilNextRefill

public long getDurationUntilNextRefill(java.util.concurrent.TimeUnit unit)
                                throws java.lang.UnsupportedOperationException

Returns the amount of time in the specified time unit until the next group of tokens can be added to the token bucket.

パラメータ:

unit - The time unit to express the return value in.

戻り値:

The amount of time until the next group of tokens can be added to the token bucket.

例外:

java.lang.UnsupportedOperationException

tryConsume

public boolean tryConsume()

Attempt to consume a single token from the bucket. If it was consumed then true is returned, otherwise false is returned.

戻り値:

true if a token was consumed, false otherwise.

tryConsume

public boolean tryConsume(long numTokens)

Attempt to consume a specified number of tokens from the bucket. If the tokens were consumed then true is returned, otherwise false is returned.

パラメータ:

numTokens - The number of tokens to consume from the bucket, must be a positive number.

戻り値:

true if the tokens were consumed, false otherwise.

consume

public void consume()

Consume a single token from the bucket. If no token is currently available then this method will block until a token becomes available.

consume

public void consume(long numTokens)

Consumes multiple tokens from the bucket. If enough tokens are not currently available then this method will block until

パラメータ:

numTokens - The number of tokens to consume from teh bucket, must be a positive number.

refill

public void refill(long numTokens)

Refills the bucket with the specified number of tokens. If the bucket is currently full or near capacity then fewer than numTokens may be added.

パラメータ:

numTokens - The number of tokens to add to the bucket.