Package io.github.bucket4j

Interface Summary

Interface	Description
AsyncBucket	Provides asynchronous API for bucket.
AsyncScheduledBucket	Provides async API for bucket that allows to use bucket as async scheduler.
AsyncVerboseBucket	Intent of this interface is to provide the verbose version of AsyncBucket API.
BlockingBucket	Provides blocking API for bucket that allows to use bucket as scheduler.
BlockingStrategy	Specifies the way to block current thread to amount of time required to refill missed number of tokens in the bucket.
Bucket	Performs rate limiting using algorithm based on top of ideas of Token Bucket.
BucketListener	Interface for listening bucket related events.
Extension<T extends AbstractBucketBuilder<T>>	Represents an extension point of bucket4j library.
TimeMeter	An abstraction over time measurement.
UninterruptibleBlockingStrategy	Specifies the way to block current thread to amount of time required to refill missed number of tokens in the bucket.
VerboseBucket	Intent of this interface is to provide the verbose version of Bucket API.

Class Summary

Class	Description
AbstractBucket
AbstractBucketBuilder<T extends AbstractBucketBuilder>	A builder for buckets.
Bandwidth	Anatomy of bandwidth:
Bucket4j	This is entry point for functionality provided bucket4j library.
BucketConfiguration
BucketExceptions
BucketState
ConfigurationBuilder	A builder for buckets.
ConsumptionProbe	Describes tokens consumed, tokens remaining, time required for token regeneration to occur, and the current bucket configuration after consumption.
EstimationProbe	Describes the estimation result.
Nothing
Refill	Specifies the speed of tokens regeneration.
SimpleBucketListener
VerboseResult<T extends Serializable>	Intention of this class is to provide wrapper around results returned by any method of VerboseBucket and AsyncVerboseBucket.

Enum Summary

Enum	Description
TokensInheritanceStrategy	Specifies the rules for inheritance of available tokens when Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) happens.

Exception Summary

Exception	Description
BucketExceptions.BucketExecutionException