com.ibm.cos.v2.retries.internal.circuitbreaker

Class TokenBucket

java.lang.Object

com.ibm.cos.v2.retries.internal.circuitbreaker.TokenBucket

public final class TokenBucket
extends Object

A lock-free implementation of a token bucket. Tokens can be acquired from the bucket as long as there is sufficient capacity in the bucket.

Method Summary

Modifier and Type	Method and Description
int	currentCapacity() Retrieve a snapshot of the current number of tokens in the bucket.
int	maxCapacity() Retrieve the maximum capacity of the bucket configured when the bucket was created.
ReleaseResponse	release(int amountToRelease) Release a certain number of tokens back to this bucket.
String	toString()
AcquireResponse	tryAcquire(int amountToAcquire) Try to acquire a certain number of tokens from this bucket.

Methods inherited from class java.lang.Object

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

Method Detail

tryAcquire

public AcquireResponse tryAcquire(int amountToAcquire)

Try to acquire a certain number of tokens from this bucket. If there aren't sufficient tokens in this bucket then AcquireResponse.acquisitionFailed() returns true.

release

public ReleaseResponse release(int amountToRelease)

Release a certain number of tokens back to this bucket. If this number of tokens would exceed the maximum number of tokens configured for the bucket, the bucket is instead set to the maximum value and the additional tokens are discarded.

currentCapacity

public int currentCapacity()

Retrieve a snapshot of the current number of tokens in the bucket. Because this number is constantly changing, it's recommended to refer to the AcquireResponse.capacityRemaining() returned by the tryAcquire(int) method whenever possible.

maxCapacity

public int maxCapacity()

Retrieve the maximum capacity of the bucket configured when the bucket was created.

toString

public String toString()

Overrides:

toString in class Object