Package io.github.bucket4j

Interface Summary

Interface	Description
BandwidthBuilder.BandwidthBuilderBuildStage	The final build stage with ability to configure optional parameters of bandwidth, like id or initial tokens
BandwidthBuilder.BandwidthBuilderCapacityStage	Capacity configuration building stage
BandwidthBuilder.BandwidthBuilderRefillStage	Stage is responsible for configuration of refilling speed
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.
BucketState
SchedulingBucket	Provides the scheduling API for Bucket.
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.
VerboseResult.Diagnostics	Describer of internal bucket state

Class Summary

Class	Description
AbstractBucket
Bandwidth
BandwidthBuilder	Provides API for bandwidth builder
BucketConfiguration
BucketExceptions
BucketState64BitsInteger
ConfigurationBuilder	The builder for BucketConfiguration
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.
LimitChecker
Nothing
Refill	Deprecated
SimpleBucketListener
VerboseResult<T>	Intention of this class is to provide wrapper around results returned by any method of VerboseBucket and AsyncVerboseBucket.

Enum Summary

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

Exception Summary

Exception	Description
BucketExceptions.BucketExecutionException
TimeoutException

Annotation Types Summary

Annotation Type	Description
Experimental	Code is marked by this annotation is intended to be used strongly by internal code and can be removed at any time without prior notice.