Module io.github.bucket4j.core
Package io.github.bucket4j
package io.github.bucket4j
-
ClassDescriptionProvides API for bandwidth builderThe final build stage with ability to configure optional parameters of bandwidth, like id or initial tokensCapacity configuration building stageStage is responsible for configuration of refilling speedProvides blocking API for bucket that allows to use bucket as scheduler.Specifies the way to block current thread to amount of time required to refill missed number of tokens in the bucket.Performs rate limiting using algorithm based on top of ideas of Token Bucket.Interface for listening bucket related events.The builder for
BucketConfigurationDescribes tokens consumed, tokens remaining, time required for token regeneration to occur, and the current bucket configuration after consumption.Describes the estimation result.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.Deprecated.Provides the scheduling API forBucket.An abstraction over time measurement.Specifies the rules for inheritance of available tokens whenBucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)happens.Specifies the way to block current thread to amount of time required to refill missed number of tokens in the bucket.Verbose API forBlockingBucketIntent of this interface is to provide the verbose version ofBucketAPI.Intention of this class is to provide wrapper around results returned by any method ofVerboseBucketandAsyncVerboseBucket.Describer of internal bucket stateVerbose API forSchedulingBucket