io.github.bucket4j

Class Bandwidth

java.lang.Object

io.github.bucket4j.Bandwidth

All Implemented Interfaces:

Serializable

public class Bandwidth
extends Object
implements Serializable

Anatomy of bandwidth:

The bandwidth is key building block for bucket. The bandwidth consists from capacity and refill. Where:

• Capacity - defines the maximum count of tokens which can be hold by bucket.
• Refill - defines the speed in which tokens are regenerated in bucket.

Classic and simple bandwidth definitions:

The bandwidth can be initialized in the two way:

• Simple - most popular way, which does not require from you to fully understand the token-bucket algorithm. Use this way when you just want to specify easy limitation N tokens per M time window. See this example of usage.
• classic(long, Refill) Classic} - hard way to specify limitation, use it when you want to utilize the whole power of token-bucket. See this example of usage.

Multiple bandwidths:

Most likely you will use only one bandwidth per bucket, but in general it is possible to specify more than one bandwidth per bucket, and bucket will handle all bandwidth in strongly atomic way. Strongly atomic means that token will be consumed from all bandwidth or from nothing, in other words any token can not be partially consumed.
Example of multiple bandwidth:

 // Adds bandwidth that restricts to consume not often 1000 tokens per 1 minute and not often than 100 tokens per second
 Bucket bucket = Bucket4j.builder().
      .addLimit(Bandwidth.create(1000, Duration.ofMinutes(1)));
      .addLimit(Bandwidth.create(100, Duration.ofSeconds(1)));
      .build()
 

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static Bandwidth	classic(long capacity, Refill refill) Specifies limitation in classic interpretation of token-bucket algorithm.
static Bandwidth	simple(long capacity, Duration period) Specifies simple limitation capacity tokens per period time window.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

simple

public static Bandwidth simple(long capacity,
                               Duration period)

Specifies simple limitation capacity tokens per period time window.

Parameters:

capacity -

period -

Returns:

classic

public static Bandwidth classic(long capacity,
                                Refill refill)

Specifies limitation in classic interpretation of token-bucket algorithm.

Parameters:

capacity -

refill -

Returns:

toString

public String toString()

Overrides:

toString in class Object