A B C D E F G H I L M N O P R S T U V W Z
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractBinaryTransaction - Class in io.github.bucket4j.distributed.remote
- AbstractBinaryTransaction(byte[]) - Constructor for class io.github.bucket4j.distributed.remote.AbstractBinaryTransaction
- AbstractBucket - Class in io.github.bucket4j
- AbstractBucket(BucketListener) - Constructor for class io.github.bucket4j.AbstractBucket
- AbstractCompareAndSwapBasedProxyManager<K> - Class in io.github.bucket4j.distributed.proxy.generic.compare_and_swap
-
The base class for proxy managers that built on top of idea that underlining storage provide transactions and locking.
- AbstractCompareAndSwapBasedProxyManager(ClientSideConfig) - Constructor for class io.github.bucket4j.distributed.proxy.generic.compare_and_swap.AbstractCompareAndSwapBasedProxyManager
- AbstractLockBasedProxyManager<K> - Class in io.github.bucket4j.distributed.proxy.generic.pessimistic_locking
-
The base class for proxy managers that built on top of idea that underlining storage provide Compare-And-Swap functionality.
- AbstractLockBasedProxyManager(ClientSideConfig) - Constructor for class io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.AbstractLockBasedProxyManager
- AbstractProxyManager<K> - Class in io.github.bucket4j.distributed.proxy
- AbstractProxyManager(ClientSideConfig) - Constructor for class io.github.bucket4j.distributed.proxy.AbstractProxyManager
- AbstractSelectForUpdateBasedProxyManager<K> - Class in io.github.bucket4j.distributed.proxy.generic.select_for_update
-
The base class for proxy managers that built on top of idea that underlining storage provide Compare-And-Swap functionality.
- AbstractSelectForUpdateBasedProxyManager(ClientSideConfig) - Constructor for class io.github.bucket4j.distributed.proxy.generic.select_for_update.AbstractSelectForUpdateBasedProxyManager
- addConsumedTokens(long) - Method in class io.github.bucket4j.distributed.remote.RemoteStat
- ADDITIVE - io.github.bucket4j.TokensInheritanceStrategy
-
Instructs to copy available tokens as is, but with one exclusion: if new bandwidth capacity is greater than old capacity, available tokens will be increased by the difference between the old and the new configuration.
- addLimit(Bandwidth) - Method in class io.github.bucket4j.ConfigurationBuilder
-
Adds limited bandwidth for all buckets which will be constructed by this builder instance.
- addLimit(Bandwidth) - Method in class io.github.bucket4j.local.LocalBucketBuilder
-
Adds limited bandwidth for all buckets which will be constructed by this builder.
- addLimit(Function<BandwidthBuilder.BandwidthBuilderCapacityStage, BandwidthBuilder.BandwidthBuilderBuildStage>) - Method in class io.github.bucket4j.ConfigurationBuilder
- addLimit(Function<BandwidthBuilder.BandwidthBuilderCapacityStage, BandwidthBuilder.BandwidthBuilderBuildStage>) - Method in class io.github.bucket4j.local.LocalBucketBuilder
- addTokens(long) - Method in class io.github.bucket4j.AbstractBucket
- addTokens(long) - Method in interface io.github.bucket4j.Bucket
-
Add tokensToAdd to bucket.
- addTokens(long) - Method in interface io.github.bucket4j.BucketState
- addTokens(long) - Method in class io.github.bucket4j.BucketState64BitsInteger
- addTokens(long) - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Asynchronous version of
Bucket.addTokens(long), follows the same semantic. - addTokens(long) - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- addTokens(long) - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.addTokens(long) - addTokens(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- addTokens(long) - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- addTokens(long) - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.addTokens(long) - AddTokensCommand - Class in io.github.bucket4j.distributed.remote.commands
- AddTokensCommand(long) - Constructor for class io.github.bucket4j.distributed.remote.commands.AddTokensCommand
- addTokensImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- addTokensImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- addTokensImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- addTokensImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- addTokensImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- addTokensVerboseImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- addTokensVerboseImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- addTokensVerboseImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- addTokensVerboseImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- addTokensVerboseImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- allocateTransaction(K, Optional<Long>) - Method in class io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.AbstractLockBasedProxyManager
- allocateTransaction(K, Optional<Long>) - Method in class io.github.bucket4j.distributed.proxy.generic.select_for_update.AbstractSelectForUpdateBasedProxyManager
- apply(AsyncCommandExecutor) - Method in class io.github.bucket4j.distributed.proxy.optimization.batch.BatchingOptimization
- apply(AsyncCommandExecutor) - Method in class io.github.bucket4j.distributed.proxy.optimization.delay.DelayOptimization
- apply(AsyncCommandExecutor) - Method in class io.github.bucket4j.distributed.proxy.optimization.manual.ManuallySyncingOptimization
- apply(AsyncCommandExecutor) - Method in interface io.github.bucket4j.distributed.proxy.optimization.Optimization
-
Decorates command executor in order to apply optimization strategy.
- apply(AsyncCommandExecutor) - Method in class io.github.bucket4j.distributed.proxy.optimization.predictive.PredictiveOptimization
- apply(AsyncCommandExecutor) - Method in class io.github.bucket4j.distributed.proxy.optimization.skiponzero.SkipSyncOnZeroOptimization
- apply(CommandExecutor) - Method in class io.github.bucket4j.distributed.proxy.optimization.batch.BatchingOptimization
- apply(CommandExecutor) - Method in class io.github.bucket4j.distributed.proxy.optimization.delay.DelayOptimization
- apply(CommandExecutor) - Method in class io.github.bucket4j.distributed.proxy.optimization.manual.ManuallySyncingOptimization
- apply(CommandExecutor) - Method in interface io.github.bucket4j.distributed.proxy.optimization.Optimization
-
Decorates command executor in order to apply optimization strategy.
- apply(CommandExecutor) - Method in class io.github.bucket4j.distributed.proxy.optimization.predictive.PredictiveOptimization
- apply(CommandExecutor) - Method in class io.github.bucket4j.distributed.proxy.optimization.skiponzero.SkipSyncOnZeroOptimization
- applyTimeout(PreparedStatement, Optional<Long>) - Method in class io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.AbstractLockBasedProxyManager
- applyTimeout(PreparedStatement, Optional<Long>) - Method in class io.github.bucket4j.distributed.proxy.generic.select_for_update.AbstractSelectForUpdateBasedProxyManager
- AS_IS - io.github.bucket4j.TokensInheritanceStrategy
-
Instructs to copy available tokens as is, but with one exclusion: if available tokens is greater than new capacity, available tokens will be decreased to new capacity.
- asAsync() - Method in class io.github.bucket4j.distributed.proxy.AbstractProxyManager
- asAsync() - Method in interface io.github.bucket4j.distributed.proxy.ProxyManager
-
Returns asynchronous API for this proxy manager.
- asBlocking() - Method in class io.github.bucket4j.AbstractBucket
- asBlocking() - Method in interface io.github.bucket4j.Bucket
-
Returns the blocking API for this bucket, that provides operations which are able to block caller thread in case of lack of tokens.
- asException() - Method in class io.github.bucket4j.distributed.remote.BucketNotFoundError
- asException() - Method in interface io.github.bucket4j.distributed.remote.CommandError
- asException() - Method in class io.github.bucket4j.distributed.remote.ConfigurationNeedToBeReplacedError
- asException() - Method in class io.github.bucket4j.distributed.remote.UnsupportedNamedTypeError
- asException() - Method in class io.github.bucket4j.distributed.remote.UnsupportedTypeError
- asException() - Method in class io.github.bucket4j.distributed.remote.UsageOfObsoleteApiError
- asException() - Method in class io.github.bucket4j.distributed.remote.UsageOfUnsupportedApiError
- asLocal() - Method in class io.github.bucket4j.distributed.remote.RemoteVerboseResult
- asScheduler() - Method in class io.github.bucket4j.AbstractBucket
- asScheduler() - Method in interface io.github.bucket4j.Bucket
-
Returns the scheduling API for this bucket, that provides operations which can delay user operation via
ScheduledExecutorServicein case of lack of tokens. - asScheduler() - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Returns asynchronous view of this bucket that allows to use bucket as async scheduler.
- asScheduler() - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- asScheduler() - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- asVerbose() - Method in class io.github.bucket4j.AbstractBucket
- asVerbose() - Method in interface io.github.bucket4j.Bucket
-
Returns the verbose API for this bucket.
- asVerbose() - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Returns the verbose view of this bucket.
- asVerbose() - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- asVerbose() - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- asVerbose() - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- AsyncBatchHelper<T,R,CT,CR> - Class in io.github.bucket4j.util.concurrent.batch
-
Helper class for batching
- AsyncBatchingExecutor - Class in io.github.bucket4j.distributed.proxy.optimization.batch
- AsyncBatchingExecutor(AsyncCommandExecutor, OptimizationListener) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.batch.AsyncBatchingExecutor
- AsyncBucketProxy - Interface in io.github.bucket4j.distributed
-
Asynchronous analog of
BucketProxy. - AsyncBucketProxyAdapter - Class in io.github.bucket4j.distributed
- AsyncBucketProxyAdapter(Bucket) - Constructor for class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- AsyncCommandExecutor - Interface in io.github.bucket4j.distributed.proxy
- AsyncCompareAndSwapOperation - Interface in io.github.bucket4j.distributed.proxy.generic.compare_and_swap
-
Describes the set of operations that
AbstractCompareAndSwapBasedProxyManagertypically performs in reaction to user request. - asyncModeIsNotSupported() - Static method in class io.github.bucket4j.BucketExceptions
- AsyncOptimizationController - Interface in io.github.bucket4j.distributed
-
The optimization controller for
AsyncBucketProxy. - AsyncProxyManager<K> - Interface in io.github.bucket4j.distributed.proxy
-
The asynchronous equivalent of
ProxyManager. - AsyncVerboseBucket - Interface in io.github.bucket4j.distributed
-
Intent of this interface is to provide the verbose version of
AsyncBucketProxyAPI.
B
- background(Executor) - Static method in interface io.github.bucket4j.distributed.proxy.ExecutionStrategy
-
This execution strategy always communicates with backend in specified executor
- backgroundTimeBounded(Executor, Duration) - Static method in interface io.github.bucket4j.distributed.proxy.ExecutionStrategy
-
This execution strategy always communicates with backend in specified executor
- BackwardCompatibilityException - Exception in io.github.bucket4j.distributed.versioning
- BackwardCompatibilityException(String) - Constructor for exception io.github.bucket4j.distributed.versioning.BackwardCompatibilityException
- backwardCompatibleWith(Version) - Method in class io.github.bucket4j.distributed.proxy.ClientSideConfig
-
Returns new instance of
ClientSideConfigwith configuredbackwardCompatibilityVersion. - Bandwidth - Class in io.github.bucket4j
- BandwidthBuilder - Class in io.github.bucket4j
-
Provides API for bandwidth builder
- BandwidthBuilder() - Constructor for class io.github.bucket4j.BandwidthBuilder
- BandwidthBuilder.BandwidthBuilderBuildStage - Interface in io.github.bucket4j
-
The final build stage with ability to configure optional parameters of bandwidth, like id or initial tokens
- BandwidthBuilder.BandwidthBuilderCapacityStage - Interface in io.github.bucket4j
-
Capacity configuration building stage
- BandwidthBuilder.BandwidthBuilderRefillStage - Interface in io.github.bucket4j
-
Stage is responsible for configuration of refilling speed
- basedOnTimeForRefillingBucketUpToMax(Duration) - Static method in interface io.github.bucket4j.distributed.ExpirationAfterWriteStrategy
-
Returns strategy that smartly calculates TTL based of current bucket state, buckets are not persisted in storage longer than time required to refill all consumed tokens plus keepAfterRefillDuration
- BatchFailedException(Throwable) - Constructor for exception io.github.bucket4j.util.concurrent.batch.BatchHelper.BatchFailedException
- BatchHelper<T,R,CT,CR> - Class in io.github.bucket4j.util.concurrent.batch
-
Helper class for batching
- BatchHelper.BatchFailedException - Exception in io.github.bucket4j.util.concurrent.batch
- batching() - Static method in class io.github.bucket4j.distributed.proxy.optimization.Optimizations
-
Creates optimization that combines independent requests to same bucket into batches in order to reduce request count to remote storage.
- BatchingExecutor - Class in io.github.bucket4j.distributed.proxy.optimization.batch
- BatchingExecutor(CommandExecutor, OptimizationListener) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.batch.BatchingExecutor
- BatchingOptimization - Class in io.github.bucket4j.distributed.proxy.optimization.batch
-
Optimization that combines independent requests to same bucket into batches in order to reduce request count to remote storage.
- BatchingOptimization(OptimizationListener) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.batch.BatchingOptimization
- beforeParking(long) - Method in interface io.github.bucket4j.BucketListener
-
This method is called each time when thread is going to be parked for wait of tokens refill in result of interaction with
BlockingBucket - begin(Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.LockBasedTransaction
-
Begins transaction if underlying storage requires transactions.
- begin(Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.select_for_update.SelectForUpdateBasedTransaction
-
Begins transaction if underlying storage requires transactions.
- beginAsyncCompareAndSwapOperation(K) - Method in class io.github.bucket4j.distributed.proxy.generic.compare_and_swap.AbstractCompareAndSwapBasedProxyManager
- beginCompareAndSwapOperation(K) - Method in class io.github.bucket4j.distributed.proxy.generic.compare_and_swap.AbstractCompareAndSwapBasedProxyManager
- BlockingBucket - Interface in io.github.bucket4j
-
Provides blocking API for bucket that allows to use bucket as scheduler.
- BlockingStrategy - Interface in io.github.bucket4j
-
Specifies the way to block current thread to amount of time required to refill missed number of tokens in the bucket.
- BOOLEAN_HANDLE - Static variable in class io.github.bucket4j.distributed.serialization.PrimitiveSerializationHandles
- boundedTimeout(TimeMeter, long) - Static method in interface io.github.bucket4j.distributed.proxy.Timeout
- Bucket - Interface in io.github.bucket4j
-
Performs rate limiting using algorithm based on top of ideas of Token Bucket.
- BucketConfiguration - Class in io.github.bucket4j
- BucketConfiguration(List<Bandwidth>) - Constructor for class io.github.bucket4j.BucketConfiguration
- BucketExceptions - Class in io.github.bucket4j
- BucketExceptions.BucketExecutionException - Exception in io.github.bucket4j
- BucketExecutionException(String) - Constructor for exception io.github.bucket4j.BucketExceptions.BucketExecutionException
- BucketExecutionException(Throwable) - Constructor for exception io.github.bucket4j.BucketExceptions.BucketExecutionException
- BucketListener - Interface in io.github.bucket4j
-
Interface for listening bucket related events.
- bucketNotFound() - Static method in class io.github.bucket4j.distributed.remote.CommandResult
- BucketNotFoundError - Class in io.github.bucket4j.distributed.remote
- BucketNotFoundError() - Constructor for class io.github.bucket4j.distributed.remote.BucketNotFoundError
- BucketNotFoundException - Exception in io.github.bucket4j.distributed.proxy
-
Exception which thrown each time when
DefaultBucketProxyfound that bucket state has been lost, andDefaultBucketProxyis unable to repair bucket state or recovery strategy isRecoveryStrategy.THROW_BUCKET_NOT_FOUND_EXCEPTION. - BucketNotFoundException() - Constructor for exception io.github.bucket4j.distributed.proxy.BucketNotFoundException
- BucketProxy - Interface in io.github.bucket4j.distributed
-
Provides a light-weight proxy to bucket which state actually stored in external storage, like in-memory jvm or relational database.
- BucketState - Interface in io.github.bucket4j
- BucketState64BitsInteger - Class in io.github.bucket4j
- BucketState64BitsInteger(BucketConfiguration, long) - Constructor for class io.github.bucket4j.BucketState64BitsInteger
- BucketTableSettings - Class in io.github.bucket4j.distributed.jdbc
- build() - Method in interface io.github.bucket4j.BandwidthBuilder.BandwidthBuilderBuildStage
-
Creates the new instance of
Bandwidth - build() - Method in class io.github.bucket4j.ConfigurationBuilder
- build() - Method in class io.github.bucket4j.local.LocalBucketBuilder
-
Constructs the bucket.
- build(DataSource) - Method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfigurationBuilder
-
The method takes a
DataSourceas a required parameter - build(K, BucketConfiguration) - Method in interface io.github.bucket4j.distributed.proxy.RemoteAsyncBucketBuilder
-
Deprecated.use
RemoteAsyncBucketBuilder.build(Object, Supplier)instead. This method will be removed soon - build(K, BucketConfiguration) - Method in interface io.github.bucket4j.distributed.proxy.RemoteBucketBuilder
-
Deprecated.use
RemoteBucketBuilder.build(Object, Supplier)instead. This method will be removed soon - build(K, Supplier<BucketConfiguration>) - Method in interface io.github.bucket4j.distributed.proxy.RemoteBucketBuilder
-
Has the same semantic with
RemoteBucketBuilder.build(Object, BucketConfiguration), but additionally provides ability to provide configuration lazily, that can be helpful when figuring-out the right configuration parameters is costly, for example because parameters for particularkeyare stored in external database,configurationSupplierwill be called if and only if bucket has not been persisted before. - build(K, Supplier<CompletableFuture<BucketConfiguration>>) - Method in interface io.github.bucket4j.distributed.proxy.RemoteAsyncBucketBuilder
-
Has the same semantic with
RemoteAsyncBucketBuilder.build(Object, BucketConfiguration), but additionally provides ability to provide configuration lazily, that can be helpful when figuring-out the right configuration parameters is costly, for example because parameters for particularkeyare stored in external database,configurationSupplierwill be called if and only if bucket has not been persisted before. - buildConfiguration() - Method in class io.github.bucket4j.ConfigurationBuilder
-
Deprecated.
- builder() - Static method in class io.github.bucket4j.Bandwidth
-
Creates a builder for
Bandwidth - builder() - Static method in class io.github.bucket4j.BandwidthBuilder
- builder() - Static method in interface io.github.bucket4j.Bucket
-
Creates the new builder of in-memory buckets.
- builder() - Static method in class io.github.bucket4j.BucketConfiguration
- builder() - Static method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfiguration
- builder() - Static method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfigurationBuilder
-
Deprecated.
- builder() - Method in class io.github.bucket4j.distributed.proxy.AbstractProxyManager
- builder() - Method in interface io.github.bucket4j.distributed.proxy.AsyncProxyManager
-
Creates new instance of
RemoteAsyncBucketBuilder - builder() - Method in interface io.github.bucket4j.distributed.proxy.ProxyManager
- byNumber(int) - Static method in enum io.github.bucket4j.distributed.versioning.Versions
- BYTES - Static variable in interface io.github.bucket4j.distributed.serialization.Mapper
C
- calculateDelayNanosAfterWillBePossibleToConsume(long, long, boolean) - Method in interface io.github.bucket4j.BucketState
- calculateDelayNanosAfterWillBePossibleToConsume(long, long, boolean) - Method in class io.github.bucket4j.BucketState64BitsInteger
- calculateDelayNanosAfterWillBePossibleToConsume(long, long, boolean) - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- calculateFullRefillingTime() - Method in interface io.github.bucket4j.VerboseResult.Diagnostics
-
Returns time in nanoseconds that need to wait until bucket will be fully refilled to its maximum
- calculateFullRefillingTime(long) - Method in interface io.github.bucket4j.BucketState
- calculateFullRefillingTime(long) - Method in class io.github.bucket4j.BucketState64BitsInteger
- calculateFullRefillingTime(long) - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- calculateTimeToLiveMillis(RemoteBucketState, long) - Method in interface io.github.bucket4j.distributed.ExpirationAfterWriteStrategy
-
Calculates the time to live for bucket that is going to be persisted to the remote storage
- call(Function<Optional<Long>, T>) - Method in interface io.github.bucket4j.distributed.proxy.Timeout
- callAsync(Function<Optional<Long>, CompletableFuture<T>>) - Method in interface io.github.bucket4j.distributed.proxy.Timeout
- canBeConsumed() - Method in class io.github.bucket4j.EstimationProbe
-
Flag describes result of consumption operation.
- canBeConsumed(long) - Static method in class io.github.bucket4j.EstimationProbe
- canBeMerged(RemoteCommand<?>) - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- canBeMerged(RemoteCommand<?>) - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- canBeMerged(RemoteCommand<?>) - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- canBeMerged(RemoteCommand<?>) - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- canNotBeConsumed(long, long) - Static method in class io.github.bucket4j.EstimationProbe
- capacity(long) - Method in interface io.github.bucket4j.BandwidthBuilder.BandwidthBuilderCapacityStage
-
Specifying capacity in terms of Token-Bucket
- check(int, Version, Version) - Static method in enum io.github.bucket4j.distributed.versioning.Versions
- checkConfiguration(BucketConfiguration) - Static method in class io.github.bucket4j.LimitChecker
- CheckConfigurationVersionAndExecuteCommand<T> - Class in io.github.bucket4j.distributed.remote.commands
- CheckConfigurationVersionAndExecuteCommand(RemoteCommand<T>, long) - Constructor for class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- checkMax(int, Versions) - Static method in enum io.github.bucket4j.distributed.versioning.Versions
- checkMaxWaitTime(long) - Static method in class io.github.bucket4j.LimitChecker
- checkMigrationMode(TokensInheritanceStrategy) - Static method in class io.github.bucket4j.LimitChecker
- checkMin(int, Versions) - Static method in enum io.github.bucket4j.distributed.versioning.Versions
- checkScheduler(ScheduledExecutorService) - Static method in class io.github.bucket4j.LimitChecker
- checkTokensToAdd(long) - Static method in class io.github.bucket4j.LimitChecker
- checkTokensToConsume(long) - Static method in class io.github.bucket4j.LimitChecker
- classic(long, Refill) - Static method in class io.github.bucket4j.Bandwidth
-
Deprecated.
- clear() - Method in class io.github.bucket4j.distributed.proxy.optimization.predictive.Sampling
- ClientSideConfig - Class in io.github.bucket4j.distributed.proxy
-
Represents additional options for
ProxyManagersuch as: Backward compatibility version, seeClientSideConfig.backwardCompatibleWith(Version)for more details. Client-side clock, seeClientSideConfig.withClientClock(TimeMeter)for more details. - ClientSideConfig(Version, Optional<TimeMeter>, ExecutionStrategy, Optional<Long>) - Constructor for class io.github.bucket4j.distributed.proxy.ClientSideConfig
- CommandError - Interface in io.github.bucket4j.distributed.remote
- CommandExecutor - Interface in io.github.bucket4j.distributed.proxy
- CommandResult<T> - Class in io.github.bucket4j.distributed.remote
- CommandResult(T, int) - Constructor for class io.github.bucket4j.distributed.remote.CommandResult
- commit(Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.LockBasedTransaction
-
Commits transaction if underlying storage requires transactions
- commit(Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.select_for_update.SelectForUpdateBasedTransaction
-
Commits transaction if underlying storage requires transactions
- ComparableByContent<T extends ComparableByContent> - Interface in io.github.bucket4j.util
- compareAndSwap(byte[], byte[], RemoteBucketState, Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.compare_and_swap.AsyncCompareAndSwapOperation
-
Compares and swap data associated with key
- compareAndSwap(byte[], byte[], RemoteBucketState, Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.compare_and_swap.CompareAndSwapOperation
-
Compares and swap data associated with key
- CompareAndSwapOperation - Interface in io.github.bucket4j.distributed.proxy.generic.compare_and_swap
- completedFuture(Supplier<T>) - Static method in class io.github.bucket4j.AbstractBucket
- ConfigurationBuilder - Class in io.github.bucket4j
-
The builder for
BucketConfiguration - ConfigurationBuilder() - Constructor for class io.github.bucket4j.ConfigurationBuilder
- configurationNeedToBeReplaced() - Static method in class io.github.bucket4j.distributed.remote.CommandResult
- ConfigurationNeedToBeReplacedError - Class in io.github.bucket4j.distributed.remote
- ConfigurationNeedToBeReplacedError() - Constructor for class io.github.bucket4j.distributed.remote.ConfigurationNeedToBeReplacedError
- consume(long) - Method in interface io.github.bucket4j.BlockingBucket
-
This is just overloaded equivalent of
BlockingBucket.consume(long, BlockingStrategy) - consume(long) - Method in interface io.github.bucket4j.BucketState
- consume(long) - Method in class io.github.bucket4j.BucketState64BitsInteger
- consume(long) - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- consume(long, BlockingStrategy) - Method in class io.github.bucket4j.AbstractBucket
- consume(long, BlockingStrategy) - Method in interface io.github.bucket4j.BlockingBucket
-
Consumes a specified number of tokens from the bucket.
- consume(long, ScheduledExecutorService) - Method in class io.github.bucket4j.AbstractBucket
- consume(long, ScheduledExecutorService) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- consume(long, ScheduledExecutorService) - Method in interface io.github.bucket4j.SchedulingBucket
-
Consumes the specified number of tokens from the bucket.
- ConsumeAsMuchAsPossibleCommand - Class in io.github.bucket4j.distributed.remote.commands
- ConsumeAsMuchAsPossibleCommand(long) - Constructor for class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- consumeAsMuchAsPossibleImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- consumeAsMuchAsPossibleImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- consumeAsMuchAsPossibleImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- consumeAsMuchAsPossibleImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- consumeAsMuchAsPossibleImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- consumeAsMuchAsPossibleVerboseImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- consumeAsMuchAsPossibleVerboseImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- consumeAsMuchAsPossibleVerboseImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- consumeAsMuchAsPossibleVerboseImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- consumeAsMuchAsPossibleVerboseImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- consumed(long, long) - Static method in class io.github.bucket4j.ConsumptionProbe
- consumeIgnoringRateLimits(long) - Method in class io.github.bucket4j.AbstractBucket
- consumeIgnoringRateLimits(long) - Method in interface io.github.bucket4j.Bucket
-
Consumes
tokensfrom bucket ignoring all limits. - consumeIgnoringRateLimits(long) - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Asynchronous version of
Bucket.consumeIgnoringRateLimits(long), follows the same semantic. - consumeIgnoringRateLimits(long) - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- consumeIgnoringRateLimits(long) - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.consumeIgnoringRateLimits(long) - consumeIgnoringRateLimits(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- consumeIgnoringRateLimits(long) - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.consumeIgnoringRateLimits(long) - ConsumeIgnoringRateLimitsCommand - Class in io.github.bucket4j.distributed.remote.commands
- ConsumeIgnoringRateLimitsCommand(long) - Constructor for class io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand
- consumeIgnoringRateLimitsImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- consumeIgnoringRateLimitsImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- consumeIgnoringRateLimitsImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- consumeIgnoringRateLimitsImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- consumeIgnoringRateLimitsImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- consumeIgnoringRateLimitsVerboseImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- consumeIgnoringRateLimitsVerboseImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- consumeIgnoringRateLimitsVerboseImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- consumeIgnoringRateLimitsVerboseImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- consumeIgnoringRateLimitsVerboseImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- consumeUninterruptibly(long) - Method in interface io.github.bucket4j.BlockingBucket
-
This is just overloaded equivalent of
BlockingBucket.consumeUninterruptibly(long, UninterruptibleBlockingStrategy) - consumeUninterruptibly(long, UninterruptibleBlockingStrategy) - Method in class io.github.bucket4j.AbstractBucket
- consumeUninterruptibly(long, UninterruptibleBlockingStrategy) - Method in interface io.github.bucket4j.BlockingBucket
-
Has same semantic with
BlockingBucket.consume(long, BlockingStrategy)but ignores interrupts(just restores interruption flag on exit). - ConsumptionProbe - Class in io.github.bucket4j
-
Describes tokens consumed, tokens remaining, time required for token regeneration to occur, and the current bucket configuration after consumption.
- copy() - Method in interface io.github.bucket4j.BucketState
- copy() - Method in class io.github.bucket4j.BucketState64BitsInteger
- copy() - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- copy() - Method in class io.github.bucket4j.distributed.remote.RemoteStat
- copyBucketState() - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- copyStateFrom(BucketState) - Method in interface io.github.bucket4j.BucketState
- copyStateFrom(BucketState) - Method in class io.github.bucket4j.BucketState64BitsInteger
- CORE_HANDLES - Static variable in class io.github.bucket4j.distributed.serialization.SerializationHandles
- create(byte[], RemoteBucketState, Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.LockBasedTransaction
-
Creates the data by the key associated with this transaction.
- create(long) - Static method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- create(Function<List<T>, CT>, Function<CT, CR>, BiFunction<CT, CR, List<R>>) - Static method in class io.github.bucket4j.util.concurrent.batch.BatchHelper
- create(Function<List<T>, CT>, Function<CT, CR>, Function<T, R>, BiFunction<CT, CR, List<R>>) - Static method in class io.github.bucket4j.util.concurrent.batch.BatchHelper
- create(Function<List<T>, CT>, Function<CT, CompletableFuture<CR>>, BiFunction<CT, CR, List<R>>) - Static method in class io.github.bucket4j.util.concurrent.batch.AsyncBatchHelper
- create(Function<List<T>, CT>, Function<CT, CompletableFuture<CR>>, Function<T, CompletableFuture<R>>, BiFunction<CT, CR, List<R>>) - Static method in class io.github.bucket4j.util.concurrent.batch.AsyncBatchHelper
- createDefault() - Static method in interface io.github.bucket4j.distributed.proxy.optimization.OptimizationListener
-
Creates new instance of
DefaultOptimizationListener - createDefault(DelayParameters) - Static method in class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
- createInitialState(BucketConfiguration, MathType, long) - Static method in interface io.github.bucket4j.BucketState
- CreateInitialStateAndExecuteCommand<T> - Class in io.github.bucket4j.distributed.remote.commands
- CreateInitialStateAndExecuteCommand(BucketConfiguration, RemoteCommand<T>) - Constructor for class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand<T> - Class in io.github.bucket4j.distributed.remote.commands
- CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand(BucketConfiguration, RemoteCommand<T>, long, TokensInheritanceStrategy) - Constructor for class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- CreateSnapshotCommand - Class in io.github.bucket4j.distributed.remote.commands
- CreateSnapshotCommand() - Constructor for class io.github.bucket4j.distributed.remote.commands.CreateSnapshotCommand
- currentTimeNanos() - Method in interface io.github.bucket4j.TimeMeter
-
Returns current time in nanosecond precision, but not necessarily nanosecond resolution.
- customSettings(String, String, String) - Static method in class io.github.bucket4j.distributed.jdbc.BucketTableSettings
-
The method will define a custom configuration of the table for the work with the PostgreSQL extension
D
- DataOutputSerializationAdapter - Class in io.github.bucket4j.distributed.serialization
- DEFAULT_MAX_SAMPLES - Static variable in class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
- DEFAULT_MIN_SAMPLES - Static variable in class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
- DefaultAsyncBucketProxy - Class in io.github.bucket4j.distributed.proxy
- DefaultAsyncBucketProxy(AsyncCommandExecutor, RecoveryStrategy, Supplier<CompletableFuture<BucketConfiguration>>, ImplicitConfigurationReplacement) - Constructor for class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- DefaultBucketProxy - Class in io.github.bucket4j.distributed.proxy
- DefaultBucketProxy(Supplier<BucketConfiguration>, CommandExecutor, RecoveryStrategy, ImplicitConfigurationReplacement) - Constructor for class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- DefaultOptimizationListener - Class in io.github.bucket4j.distributed.proxy.optimization
-
The simple listener that just stores all events as AtomicLong counters and provides getters for them.
- DefaultOptimizationListener() - Constructor for class io.github.bucket4j.distributed.proxy.optimization.DefaultOptimizationListener
- delaying(DelayParameters) - Static method in class io.github.bucket4j.distributed.proxy.optimization.Optimizations
-
Creates optimization that can serve requests locally without synchronization with external storage until thresholds are not violated.
- DelayOptimization - Class in io.github.bucket4j.distributed.proxy.optimization.delay
-
Optimization that can serve requests locally without synchronization with external storage until thresholds are not violated.
- DelayOptimization(DelayParameters, OptimizationListener, TimeMeter) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.delay.DelayOptimization
- DelayParameters - Class in io.github.bucket4j.distributed.proxy.optimization
-
Describes parameters for
DelayOptimization. - DelayParameters(long, Duration) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.DelayParameters
-
Creates the new instance of
DelayParameters - DeserializationAdapter<S> - Interface in io.github.bucket4j.distributed.serialization
- deserialize(DeserializationAdapter<I>, I) - Static method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- deserialize(DeserializationAdapter<I>, I) - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- deserialize(DeserializationAdapter<S>, S) - Static method in interface io.github.bucket4j.BucketState
- deserializeRequest(byte[]) - Static method in class io.github.bucket4j.distributed.serialization.InternalSerializationHelper
- deserializeResult(byte[], Version) - Static method in class io.github.bucket4j.distributed.serialization.InternalSerializationHelper
- deserializeState(byte[]) - Static method in class io.github.bucket4j.distributed.serialization.InternalSerializationHelper
E
- empty() - Static method in class io.github.bucket4j.distributed.remote.CommandResult
- equals(Object) - Method in class io.github.bucket4j.Bandwidth
- equals(Object) - Method in class io.github.bucket4j.BucketConfiguration
- equals(T, T) - Static method in interface io.github.bucket4j.util.ComparableByContent
- equalsByContent(Bandwidth) - Method in class io.github.bucket4j.Bandwidth
- equalsByContent(BucketConfiguration) - Method in class io.github.bucket4j.BucketConfiguration
- equalsByContent(BucketState64BitsInteger) - Method in class io.github.bucket4j.BucketState64BitsInteger
- equalsByContent(ConsumptionProbe) - Method in class io.github.bucket4j.ConsumptionProbe
- equalsByContent(BucketNotFoundError) - Method in class io.github.bucket4j.distributed.remote.BucketNotFoundError
- equalsByContent(CommandResult) - Method in class io.github.bucket4j.distributed.remote.CommandResult
- equalsByContent(AddTokensCommand) - Method in class io.github.bucket4j.distributed.remote.commands.AddTokensCommand
- equalsByContent(CheckConfigurationVersionAndExecuteCommand<?>) - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- equalsByContent(ConsumeAsMuchAsPossibleCommand) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- equalsByContent(ConsumeIgnoringRateLimitsCommand) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand
- equalsByContent(CreateInitialStateAndExecuteCommand) - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- equalsByContent(CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand) - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- equalsByContent(CreateSnapshotCommand) - Method in class io.github.bucket4j.distributed.remote.commands.CreateSnapshotCommand
- equalsByContent(EstimateAbilityToConsumeCommand) - Method in class io.github.bucket4j.distributed.remote.commands.EstimateAbilityToConsumeCommand
- equalsByContent(ForceAddTokensCommand) - Method in class io.github.bucket4j.distributed.remote.commands.ForceAddTokensCommand
- equalsByContent(GetAvailableTokensCommand) - Method in class io.github.bucket4j.distributed.remote.commands.GetAvailableTokensCommand
- equalsByContent(GetConfigurationCommand) - Method in class io.github.bucket4j.distributed.remote.commands.GetConfigurationCommand
- equalsByContent(MultiCommand) - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- equalsByContent(ReplaceConfigurationCommand) - Method in class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- equalsByContent(ReserveAndCalculateTimeToSleepCommand) - Method in class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- equalsByContent(ResetCommand) - Method in class io.github.bucket4j.distributed.remote.commands.ResetCommand
- equalsByContent(SyncCommand) - Method in class io.github.bucket4j.distributed.remote.commands.SyncCommand
- equalsByContent(TryConsumeAndReturnRemainingTokensCommand) - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand
- equalsByContent(TryConsumeCommand) - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- equalsByContent(VerboseCommand<?>) - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- equalsByContent(ConfigurationNeedToBeReplacedError) - Method in class io.github.bucket4j.distributed.remote.ConfigurationNeedToBeReplacedError
- equalsByContent(MultiResult) - Method in class io.github.bucket4j.distributed.remote.MultiResult
- equalsByContent(RemoteBucketState) - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- equalsByContent(RemoteStat) - Method in class io.github.bucket4j.distributed.remote.RemoteStat
- equalsByContent(RemoteVerboseResult<?>) - Method in class io.github.bucket4j.distributed.remote.RemoteVerboseResult
- equalsByContent(Request<T>) - Method in class io.github.bucket4j.distributed.remote.Request
- equalsByContent(UnsupportedNamedTypeError) - Method in class io.github.bucket4j.distributed.remote.UnsupportedNamedTypeError
- equalsByContent(UnsupportedTypeError) - Method in class io.github.bucket4j.distributed.remote.UnsupportedTypeError
- equalsByContent(UsageOfObsoleteApiError) - Method in class io.github.bucket4j.distributed.remote.UsageOfObsoleteApiError
- equalsByContent(UsageOfUnsupportedApiError) - Method in class io.github.bucket4j.distributed.remote.UsageOfUnsupportedApiError
- equalsByContent(EstimationProbe) - Method in class io.github.bucket4j.EstimationProbe
- equalsByContent(LockFreeBucket) - Method in class io.github.bucket4j.local.LockFreeBucket
- equalsByContent(SynchronizedBucket) - Method in class io.github.bucket4j.local.SynchronizedBucket
- equalsByContent(ThreadUnsafeBucket) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- equalsByContent(VerboseResult<?>) - Method in class io.github.bucket4j.VerboseResult
- equalsByContent(T) - Method in interface io.github.bucket4j.util.ComparableByContent
- estimateAbilityToConsume(long) - Method in class io.github.bucket4j.AbstractBucket
- estimateAbilityToConsume(long) - Method in interface io.github.bucket4j.Bucket
-
Estimates ability to consume a specified number of tokens.
- estimateAbilityToConsume(long) - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Asynchronous version of
Bucket.estimateAbilityToConsume(long), follows the same semantic. - estimateAbilityToConsume(long) - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- estimateAbilityToConsume(long) - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.estimateAbilityToConsume(long) - estimateAbilityToConsume(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- estimateAbilityToConsume(long) - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.estimateAbilityToConsume(long) - EstimateAbilityToConsumeCommand - Class in io.github.bucket4j.distributed.remote.commands
- EstimateAbilityToConsumeCommand(long) - Constructor for class io.github.bucket4j.distributed.remote.commands.EstimateAbilityToConsumeCommand
- estimateAbilityToConsumeImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- estimateAbilityToConsumeImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- estimateAbilityToConsumeImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- estimateAbilityToConsumeImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- estimateAbilityToConsumeImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- estimateAbilityToConsumeVerboseImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- estimateAbilityToConsumeVerboseImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- estimateAbilityToConsumeVerboseImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- estimateAbilityToConsumeVerboseImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- estimateAbilityToConsumeVerboseImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.AddTokensCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.CreateSnapshotCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.EstimateAbilityToConsumeCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.ForceAddTokensCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.GetAvailableTokensCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.GetConfigurationCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.ResetCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.SyncCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- estimateTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- estimateTokensToConsume() - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- EstimationProbe - Class in io.github.bucket4j
-
Describes the estimation result.
- execute() - Method in class io.github.bucket4j.distributed.remote.AbstractBinaryTransaction
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.AddTokensCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.CreateSnapshotCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.EstimateAbilityToConsumeCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.ForceAddTokensCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.GetAvailableTokensCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.GetConfigurationCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.ResetCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.SyncCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- execute(MutableBucketEntry, long) - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- execute(MutableBucketEntry, long) - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- execute(RemoteCommand<T>) - Method in interface io.github.bucket4j.distributed.proxy.CommandExecutor
- execute(RemoteCommand<T>) - Method in class io.github.bucket4j.distributed.proxy.optimization.batch.BatchingExecutor
- execute(Supplier<T>) - Method in interface io.github.bucket4j.distributed.proxy.ExecutionStrategy
- execute(K, Request<T>) - Method in class io.github.bucket4j.distributed.proxy.AbstractProxyManager
- execute(K, Request<T>) - Method in class io.github.bucket4j.distributed.proxy.generic.compare_and_swap.AbstractCompareAndSwapBasedProxyManager
- execute(K, Request<T>) - Method in class io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.AbstractLockBasedProxyManager
- execute(K, Request<T>) - Method in class io.github.bucket4j.distributed.proxy.generic.select_for_update.AbstractSelectForUpdateBasedProxyManager
- execute(T) - Method in class io.github.bucket4j.util.concurrent.batch.BatchHelper
- executeAsync(RemoteCommand<T>) - Method in interface io.github.bucket4j.distributed.proxy.AsyncCommandExecutor
- executeAsync(RemoteCommand<T>) - Method in class io.github.bucket4j.distributed.proxy.optimization.batch.AsyncBatchingExecutor
- executeAsync(Supplier<CompletableFuture<T>>) - Method in interface io.github.bucket4j.distributed.proxy.ExecutionStrategy
- executeAsync(K, Request<T>) - Method in class io.github.bucket4j.distributed.proxy.AbstractProxyManager
- executeAsync(K, Request<T>) - Method in class io.github.bucket4j.distributed.proxy.generic.compare_and_swap.AbstractCompareAndSwapBasedProxyManager
- executeAsync(K, Request<T>) - Method in class io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.AbstractLockBasedProxyManager
- executeAsync(K, Request<T>) - Method in class io.github.bucket4j.distributed.proxy.generic.select_for_update.AbstractSelectForUpdateBasedProxyManager
- executeAsync(T) - Method in class io.github.bucket4j.util.concurrent.batch.AsyncBatchHelper
- executionException(Throwable) - Static method in class io.github.bucket4j.BucketExceptions
- ExecutionStrategy - Interface in io.github.bucket4j.distributed.proxy
-
Defines the strategy for request execution.
- exists() - Method in class io.github.bucket4j.distributed.remote.AbstractBinaryTransaction
- exists() - Method in class io.github.bucket4j.distributed.remote.MutableBucketEntry
- Experimental - Annotation Type in io.github.bucket4j
-
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.
- ExpirationAfterWriteStrategy - Interface in io.github.bucket4j.distributed
-
Represents the strategy for choosing time to live for buckets in the cache.
F
- failedFuture(Throwable) - Static method in class io.github.bucket4j.AbstractBucket
- FALSE - Static variable in class io.github.bucket4j.distributed.remote.CommandResult
- fixedTimeToLive(Duration) - Static method in interface io.github.bucket4j.distributed.ExpirationAfterWriteStrategy
-
Returns strategy that makes to store buckets with fixed TTL.
- forceAddTokens(long) - Method in class io.github.bucket4j.AbstractBucket
- forceAddTokens(long) - Method in interface io.github.bucket4j.Bucket
-
Add tokensToAdd to bucket.
- forceAddTokens(long) - Method in interface io.github.bucket4j.BucketState
- forceAddTokens(long) - Method in class io.github.bucket4j.BucketState64BitsInteger
- forceAddTokens(long) - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Asynchronous version of
Bucket.forceAddTokens(long), follows the same semantic. - forceAddTokens(long) - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- forceAddTokens(long) - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.addTokens(long) - forceAddTokens(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- forceAddTokens(long) - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- forceAddTokens(long) - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.forceAddTokens(long) - ForceAddTokensCommand - Class in io.github.bucket4j.distributed.remote.commands
- ForceAddTokensCommand(long) - Constructor for class io.github.bucket4j.distributed.remote.commands.ForceAddTokensCommand
- forceAddTokensImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- forceAddTokensImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- forceAddTokensImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- forceAddTokensImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- forceAddTokensImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- forceAddTokensVerboseImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- forceAddTokensVerboseImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- forceAddTokensVerboseImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- forceAddTokensVerboseImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- forceAddTokensVerboseImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- foundTwoBandwidthsWithSameId(int, int, String) - Static method in class io.github.bucket4j.BucketExceptions
- from(RemoteCommand<T>) - Static method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- from(Throwable) - Static method in class io.github.bucket4j.BucketExceptions
- fromBinarySnapshot(byte[]) - Static method in interface io.github.bucket4j.local.LocalBucket
-
Reconstructs a bucket from binary snapshot.
- fromJsonCompatibleSnapshot(Map<String, Object>) - Static method in interface io.github.bucket4j.BucketState
- fromJsonCompatibleSnapshot(Map<String, Object>) - Static method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- fromJsonCompatibleSnapshot(Map<String, Object>) - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- fromJsonCompatibleSnapshot(Map<String, Object>) - Static method in interface io.github.bucket4j.local.LocalBucket
-
Reconstructs a bucket from JSON snapshot.
- fromSync(Bucket) - Static method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
-
TODO
G
- get() - Method in class io.github.bucket4j.distributed.remote.MutableBucketEntry
- getAllHandles() - Method in class io.github.bucket4j.distributed.serialization.SerializationHandles
- getAvailableTokens() - Method in interface io.github.bucket4j.Bucket
-
Returns amount of available tokens in this bucket.
- getAvailableTokens() - Method in interface io.github.bucket4j.BucketState
- getAvailableTokens() - Method in class io.github.bucket4j.BucketState64BitsInteger
- getAvailableTokens() - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Returns amount of available tokens in this bucket.
- getAvailableTokens() - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- getAvailableTokens() - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.getAvailableTokens() - getAvailableTokens() - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- getAvailableTokens() - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- getAvailableTokens() - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- getAvailableTokens() - Method in class io.github.bucket4j.local.LockFreeBucket
- getAvailableTokens() - Method in class io.github.bucket4j.local.SynchronizedBucket
- getAvailableTokens() - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- getAvailableTokens() - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.getAvailableTokens() - getAvailableTokens() - Method in interface io.github.bucket4j.VerboseResult.Diagnostics
-
Returns currently available tokens
- GetAvailableTokensCommand - Class in io.github.bucket4j.distributed.remote.commands
- GetAvailableTokensCommand() - Constructor for class io.github.bucket4j.distributed.remote.commands.GetAvailableTokensCommand
- getAvailableTokensPerEachBandwidth() - Method in interface io.github.bucket4j.VerboseResult.Diagnostics
-
Returns currently available tokens per each bandwidth.
- getAvailableTokensVerboseImpl() - Method in class io.github.bucket4j.AbstractBucket
- getAvailableTokensVerboseImpl() - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- getAvailableTokensVerboseImpl() - Method in class io.github.bucket4j.local.LockFreeBucket
- getAvailableTokensVerboseImpl() - Method in class io.github.bucket4j.local.SynchronizedBucket
- getAvailableTokensVerboseImpl() - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- getBackwardCompatibilityVersion() - Method in class io.github.bucket4j.distributed.proxy.AbstractProxyManager
- getBackwardCompatibilityVersion() - Method in class io.github.bucket4j.distributed.proxy.ClientSideConfig
-
Returns the Bucket4j protocol version is used to be backward compatible with other nodes in the cluster.
- getBackwardCompatibilityVersion() - Method in class io.github.bucket4j.distributed.remote.Request
- getBandwidths() - Method in class io.github.bucket4j.BucketConfiguration
- getById(byte) - Static method in enum io.github.bucket4j.TokensInheritanceStrategy
- getCapacity() - Method in class io.github.bucket4j.Bandwidth
- getClientSideClock() - Method in class io.github.bucket4j.distributed.proxy.ClientSideConfig
-
Returns clock that will be used for time measurement.
- getClientSideConfig() - Method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfiguration
- getClientSideConfig() - Method in class io.github.bucket4j.distributed.proxy.AbstractProxyManager
- getClientSideTime() - Method in class io.github.bucket4j.distributed.proxy.AbstractProxyManager
- getClientSideTime() - Method in class io.github.bucket4j.distributed.remote.Request
- getCommand() - Method in class io.github.bucket4j.distributed.remote.Request
- getCommands() - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- getConfiguration() - Method in interface io.github.bucket4j.BucketState
- getConfiguration() - Method in class io.github.bucket4j.BucketState64BitsInteger
- getConfiguration() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- getConfiguration() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- getConfiguration() - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- getConfiguration() - Method in interface io.github.bucket4j.local.LocalBucket
-
Returns configuration of this bucket.
- getConfiguration() - Method in class io.github.bucket4j.local.LockFreeBucket
- getConfiguration() - Method in class io.github.bucket4j.local.SynchronizedBucket
- getConfiguration() - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- getConfiguration() - Method in class io.github.bucket4j.VerboseResult
- GetConfigurationCommand - Class in io.github.bucket4j.distributed.remote.commands
- GetConfigurationCommand() - Constructor for class io.github.bucket4j.distributed.remote.commands.GetConfigurationCommand
- getConfigurationVersion() - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- getConsumed() - Method in class io.github.bucket4j.SimpleBucketListener
- getConsumedTokens() - Method in class io.github.bucket4j.distributed.remote.RemoteStat
- getConsumedTokens(BucketConfiguration) - Method in class io.github.bucket4j.distributed.remote.commands.GetConfigurationCommand
- getConsumedTokens(ConsumptionProbe) - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand
- getConsumedTokens(MultiResult) - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- getConsumedTokens(RemoteBucketState) - Method in class io.github.bucket4j.distributed.remote.commands.CreateSnapshotCommand
- getConsumedTokens(RemoteVerboseResult<T>) - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- getConsumedTokens(EstimationProbe) - Method in class io.github.bucket4j.distributed.remote.commands.EstimateAbilityToConsumeCommand
- getConsumedTokens(Nothing) - Method in class io.github.bucket4j.distributed.remote.commands.AddTokensCommand
- getConsumedTokens(Nothing) - Method in class io.github.bucket4j.distributed.remote.commands.ForceAddTokensCommand
- getConsumedTokens(Nothing) - Method in class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- getConsumedTokens(Nothing) - Method in class io.github.bucket4j.distributed.remote.commands.ResetCommand
- getConsumedTokens(Nothing) - Method in class io.github.bucket4j.distributed.remote.commands.SyncCommand
- getConsumedTokens(Boolean) - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- getConsumedTokens(Long) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- getConsumedTokens(Long) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand
- getConsumedTokens(Long) - Method in class io.github.bucket4j.distributed.remote.commands.GetAvailableTokensCommand
- getConsumedTokens(Long) - Method in class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- getConsumedTokens(T) - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- getConsumedTokens(T) - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- getConsumedTokens(T) - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- getConsumedTokens(T) - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- getCurrentSize(int) - Method in interface io.github.bucket4j.BucketState
- getCurrentSize(int) - Method in class io.github.bucket4j.BucketState64BitsInteger
- getData() - Method in class io.github.bucket4j.distributed.proxy.generic.select_for_update.LockAndGetResult
- getData() - Method in class io.github.bucket4j.distributed.remote.CommandResult
- getDataSource() - Method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfiguration
- getDefault() - Static method in class io.github.bucket4j.distributed.jdbc.BucketTableSettings
-
The method will define the default configuration of the table for the work with the PostgreSQL extension
- getDefault() - Static method in class io.github.bucket4j.distributed.proxy.ClientSideConfig
-
Returns default client-side configuration for proxy-manager that configured with following parameters: Client-clock: is null.
- getDelayedNanos() - Method in class io.github.bucket4j.SimpleBucketListener
- getDesiredConfigurationVersion() - Method in class io.github.bucket4j.distributed.proxy.ImplicitConfigurationReplacement
- getDesiredConfigurationVersion() - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- getDesiredConfigurationVersion() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- getDiagnostics() - Method in class io.github.bucket4j.VerboseResult
- getExecutionStrategy() - Method in class io.github.bucket4j.distributed.proxy.ClientSideConfig
-
Returns the strategy for request execution
- getHandleByTypeId(int) - Method in class io.github.bucket4j.distributed.serialization.SerializationHandles
- getHandleByTypeName(String) - Method in class io.github.bucket4j.distributed.serialization.SerializationHandles
- getId() - Method in class io.github.bucket4j.Bandwidth
- getId() - Method in enum io.github.bucket4j.TokensInheritanceStrategy
- getIdName() - Method in class io.github.bucket4j.distributed.jdbc.BucketTableSettings
- getIdName() - Method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfiguration
- getInitialTokens() - Method in class io.github.bucket4j.Bandwidth
- getInterrupted() - Method in class io.github.bucket4j.SimpleBucketListener
- getLastSyncTimeNanos() - Method in class io.github.bucket4j.distributed.proxy.optimization.predictive.Sampling
- getLatest() - Static method in enum io.github.bucket4j.distributed.versioning.Versions
- getLimit() - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- getListener() - Method in class io.github.bucket4j.AbstractBucket
- getMathType() - Method in interface io.github.bucket4j.BucketState
- getMathType() - Method in class io.github.bucket4j.BucketState64BitsInteger
- getMaxSamples() - Method in class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
- getMaxSupportedFormatNumber() - Method in class io.github.bucket4j.distributed.remote.UsageOfUnsupportedApiError
- getMaxSupportedFormatNumber() - Method in exception io.github.bucket4j.distributed.versioning.UsageOfUnsupportedApiException
- getMergeCount() - Method in class io.github.bucket4j.distributed.proxy.optimization.DefaultOptimizationListener
- getMergedCommandsCount() - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- getMergedCommandsCount() - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- getMergedCommandsCount() - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- getMergedCommandsCount() - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- getMergedCommandsCount() - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- getMinSamples() - Method in class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
- getMinSupportedFormatNumber() - Method in class io.github.bucket4j.distributed.remote.UsageOfObsoleteApiError
- getMinSupportedFormatNumber() - Method in exception io.github.bucket4j.distributed.versioning.UsageOfObsoleteApiException
- getNanosElapsed() - Method in exception io.github.bucket4j.TimeoutException
- getNanosSinceLastSync() - Method in class io.github.bucket4j.distributed.remote.commands.SyncCommand
- getNanosToWaitForRefill() - Method in class io.github.bucket4j.ConsumptionProbe
-
Returns zero if
ConsumptionProbe.isConsumed()returns true, else time in nanos which need to wait until requested amount of tokens will be refilled - getNanosToWaitForRefill() - Method in class io.github.bucket4j.EstimationProbe
-
Returns zero if
EstimationProbe.canBeConsumed()returns true, else time in nanos which need to wait until requested amount of tokens will be refilled - getNanosToWaitForReset() - Method in class io.github.bucket4j.ConsumptionProbe
-
Time in nanos which need to wait until bucket will be fully refilled to its maximum
- getNewConfiguration() - Method in class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- getNumber() - Method in interface io.github.bucket4j.distributed.versioning.Version
- getNumber() - Method in enum io.github.bucket4j.distributed.versioning.Versions
- getNumber() - Method in class io.github.bucket4j.distributed.versioning.Versions.UnknownVersion
- getOldest() - Static method in enum io.github.bucket4j.distributed.versioning.Versions
- getOperationTimeNanos() - Method in class io.github.bucket4j.distributed.remote.RemoteVerboseResult
- getOperationTimeNanos() - Method in class io.github.bucket4j.VerboseResult
- getOptimizationController() - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Returns optimization controller for this proxy.
- getOptimizationController() - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- getOptimizationController() - Method in interface io.github.bucket4j.distributed.BucketProxy
-
Returns optimization controller for this proxy.
- getOptimizationController() - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- getOptimizationController() - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- getParkedNanos() - Method in class io.github.bucket4j.SimpleBucketListener
- getPrimaryKeyMapper() - Method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfiguration
- getProxyConfiguration(K) - Method in class io.github.bucket4j.distributed.proxy.AbstractProxyManager
- getProxyConfiguration(K) - Method in interface io.github.bucket4j.distributed.proxy.AsyncProxyManager
-
Asynchronously locates configuration of bucket which actually stored in the underlying storage.
- getProxyConfiguration(K) - Method in interface io.github.bucket4j.distributed.proxy.ProxyManager
-
Locates configuration of bucket which actually stored in the underlying storage.
- getRawState() - Method in class io.github.bucket4j.distributed.remote.AbstractBinaryTransaction
- getRefillPeriodNanos() - Method in class io.github.bucket4j.Bandwidth
- getRefillTokens() - Method in class io.github.bucket4j.Bandwidth
- getRejected() - Method in class io.github.bucket4j.SimpleBucketListener
- getRemainingTokens() - Method in class io.github.bucket4j.ConsumptionProbe
-
Return the tokens remaining in the bucket
- getRemainingTokens() - Method in class io.github.bucket4j.EstimationProbe
-
Return the tokens remaining in the bucket
- getRemoteStat() - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- getRequestedFormatNumber() - Method in class io.github.bucket4j.distributed.remote.UsageOfObsoleteApiError
- getRequestedFormatNumber() - Method in class io.github.bucket4j.distributed.remote.UsageOfUnsupportedApiError
- getRequestedFormatNumber() - Method in exception io.github.bucket4j.distributed.versioning.UsageOfObsoleteApiException
- getRequestedFormatNumber() - Method in exception io.github.bucket4j.distributed.versioning.UsageOfUnsupportedApiException
- getRequestTimeoutNanos() - Method in class io.github.bucket4j.distributed.proxy.ClientSideConfig
-
Returns timeout for remote operations
- getRequestTimeoutNanos() - Method in exception io.github.bucket4j.TimeoutException
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.AddTokensCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.CreateSnapshotCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.EstimateAbilityToConsumeCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.ForceAddTokensCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.GetAvailableTokensCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.GetConfigurationCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.ResetCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.SyncCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- getRequiredVersion() - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- getRequiredVersion() - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- getResults() - Method in class io.github.bucket4j.distributed.remote.MultiResult
- getResultTypeId() - Method in class io.github.bucket4j.distributed.remote.CommandResult
- getRoundingError(int) - Method in interface io.github.bucket4j.BucketState
- getRoundingError(int) - Method in class io.github.bucket4j.BucketState64BitsInteger
- getSampleMaxAgeNanos() - Method in class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.AddTokensCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.CreateSnapshotCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.EstimateAbilityToConsumeCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.ForceAddTokensCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.GetAvailableTokensCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.GetConfigurationCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.ResetCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.SyncCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- getSerializationHandle() - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- getSerializationHandle() - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- getSerializedType() - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- getSkipCount() - Method in class io.github.bucket4j.distributed.proxy.optimization.DefaultOptimizationListener
- getState() - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- getState() - Method in class io.github.bucket4j.distributed.remote.RemoteVerboseResult
- getState() - Method in class io.github.bucket4j.VerboseResult
- getStateBytes(Version) - Method in class io.github.bucket4j.distributed.remote.MutableBucketEntry
- getStateData(Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.compare_and_swap.AsyncCompareAndSwapOperation
-
Reads data if it exists
- getStateData(Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.compare_and_swap.CompareAndSwapOperation
-
Reads data if it exists
- getStateName() - Method in class io.github.bucket4j.distributed.jdbc.BucketTableSettings
- getStateName() - Method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfiguration
- getSynchronizationStrategy() - Method in interface io.github.bucket4j.local.LocalBucket
-
Returns the synchronization strategy that is used by this bucket
- getSynchronizationStrategy() - Method in class io.github.bucket4j.local.LockFreeBucket
- getSynchronizationStrategy() - Method in class io.github.bucket4j.local.SynchronizedBucket
- getSynchronizationStrategy() - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- getTableName() - Method in class io.github.bucket4j.distributed.jdbc.BucketTableSettings
- getTableName() - Method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfiguration
- getTargetCommand() - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- getTargetCommand() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- getTargetCommand() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- getTargetCommand() - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- getTimeMeter() - Method in interface io.github.bucket4j.local.LocalBucket
-
Returns the clock that is used by this bucket
- getTimeMeter() - Method in class io.github.bucket4j.local.LockFreeBucket
- getTimeMeter() - Method in class io.github.bucket4j.local.SynchronizedBucket
- getTimeMeter() - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- getTimeOfFirstRefillMillis() - Method in class io.github.bucket4j.Bandwidth
- getTokensInheritanceStrategy() - Method in class io.github.bucket4j.distributed.proxy.ImplicitConfigurationReplacement
- getTokensInheritanceStrategy() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- getTokensInheritanceStrategy() - Method in class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- getTokensToAdd() - Method in class io.github.bucket4j.distributed.remote.commands.AddTokensCommand
- getTokensToAdd() - Method in class io.github.bucket4j.distributed.remote.commands.ForceAddTokensCommand
- getTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand
- getTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.EstimateAbilityToConsumeCommand
- getTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- getTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand
- getTokensToConsume() - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- getTypeId() - Method in class io.github.bucket4j.distributed.remote.UnsupportedTypeError
- getTypeId() - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- getTypeId() - Method in exception io.github.bucket4j.distributed.versioning.UnsupportedTypeException
- getTypeName() - Method in class io.github.bucket4j.distributed.remote.UnsupportedNamedTypeError
- getTypeName() - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- getTypeName() - Method in exception io.github.bucket4j.distributed.versioning.UnsupportedNamedTypeException
- getUnsynchronizedTokens() - Method in class io.github.bucket4j.distributed.remote.commands.SyncCommand
- getValue() - Method in class io.github.bucket4j.distributed.remote.RemoteVerboseResult
- getValue() - Method in class io.github.bucket4j.VerboseResult
- getWaitIfBusyNanosLimit() - Method in class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- greedy(long, Duration) - Static method in class io.github.bucket4j.Refill
-
Deprecated.
H
- hashCode() - Method in class io.github.bucket4j.Bandwidth
- hashCode() - Method in class io.github.bucket4j.BucketConfiguration
- hasId() - Method in class io.github.bucket4j.Bandwidth
I
- id(String) - Method in interface io.github.bucket4j.BandwidthBuilder.BandwidthBuilderBuildStage
-
By default, new created bandwidth has no ID.
- ImplicitConfigurationReplacement - Class in io.github.bucket4j.distributed.proxy
- ImplicitConfigurationReplacement(long, TokensInheritanceStrategy) - Constructor for class io.github.bucket4j.distributed.proxy.ImplicitConfigurationReplacement
- incrementMergeCount(int) - Method in class io.github.bucket4j.distributed.proxy.optimization.DefaultOptimizationListener
- incrementMergeCount(int) - Method in class io.github.bucket4j.distributed.proxy.optimization.NopeOptimizationListener
- incrementMergeCount(int) - Method in interface io.github.bucket4j.distributed.proxy.optimization.OptimizationListener
-
This method is invoked every time when several independent requests to the same bucket combined into a single one.
- incrementSkipCount(int) - Method in class io.github.bucket4j.distributed.proxy.optimization.DefaultOptimizationListener
- incrementSkipCount(int) - Method in class io.github.bucket4j.distributed.proxy.optimization.NopeOptimizationListener
- incrementSkipCount(int) - Method in interface io.github.bucket4j.distributed.proxy.optimization.OptimizationListener
-
This method is invoked every time when several requests were not propagated to external storage because optimization had decided that they can be served locally.
- INFINITY_DURATION - Static variable in class io.github.bucket4j.AbstractBucket
- INFINITY_DURATION - Static variable in class io.github.bucket4j.LimitChecker
- initialTokens(long) - Method in interface io.github.bucket4j.BandwidthBuilder.BandwidthBuilderBuildStage
-
By default, new created
Bandwidthhas amount tokens that equals its capacity. - INSTANCE - Static variable in class io.github.bucket4j.distributed.proxy.optimization.NopeOptimizationListener
- INSTANCE - Static variable in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- INSTANCE - Static variable in class io.github.bucket4j.Nothing
- INT - Static variable in interface io.github.bucket4j.distributed.jdbc.PrimaryKeyMapper
- INT - Static variable in interface io.github.bucket4j.distributed.serialization.Mapper
- INTEGER_64_BITS - io.github.bucket4j.MathType
-
The default math precision that uses integer arithmetic with 64 bits numbers.
- InternalSerializationHelper - Class in io.github.bucket4j.distributed.serialization
- InternalSerializationHelper() - Constructor for class io.github.bucket4j.distributed.serialization.InternalSerializationHelper
- intervally(long, Duration) - Static method in class io.github.bucket4j.Refill
-
Deprecated.
- intervallyAligned(long, Duration, Instant, boolean) - Static method in class io.github.bucket4j.Refill
-
Deprecated.
- intervallyAlignedRefillCompatibleOnlyWithWallClock() - Static method in class io.github.bucket4j.BucketExceptions
- intervallyAlignedRefillWithAdaptiveInitialTokensIncompatipleWithManualSpecifiedInitialTokens() - Static method in class io.github.bucket4j.BucketExceptions
- io.github.bucket4j - package io.github.bucket4j
- io.github.bucket4j.core - module io.github.bucket4j.core
- io.github.bucket4j.distributed - package io.github.bucket4j.distributed
- io.github.bucket4j.distributed.jdbc - package io.github.bucket4j.distributed.jdbc
- io.github.bucket4j.distributed.proxy - package io.github.bucket4j.distributed.proxy
- io.github.bucket4j.distributed.proxy.generic.compare_and_swap - package io.github.bucket4j.distributed.proxy.generic.compare_and_swap
- io.github.bucket4j.distributed.proxy.generic.pessimistic_locking - package io.github.bucket4j.distributed.proxy.generic.pessimistic_locking
- io.github.bucket4j.distributed.proxy.generic.select_for_update - package io.github.bucket4j.distributed.proxy.generic.select_for_update
- io.github.bucket4j.distributed.proxy.optimization - package io.github.bucket4j.distributed.proxy.optimization
- io.github.bucket4j.distributed.proxy.optimization.batch - package io.github.bucket4j.distributed.proxy.optimization.batch
- io.github.bucket4j.distributed.proxy.optimization.delay - package io.github.bucket4j.distributed.proxy.optimization.delay
- io.github.bucket4j.distributed.proxy.optimization.manual - package io.github.bucket4j.distributed.proxy.optimization.manual
- io.github.bucket4j.distributed.proxy.optimization.predictive - package io.github.bucket4j.distributed.proxy.optimization.predictive
- io.github.bucket4j.distributed.proxy.optimization.skiponzero - package io.github.bucket4j.distributed.proxy.optimization.skiponzero
- io.github.bucket4j.distributed.remote - package io.github.bucket4j.distributed.remote
- io.github.bucket4j.distributed.remote.commands - package io.github.bucket4j.distributed.remote.commands
- io.github.bucket4j.distributed.serialization - package io.github.bucket4j.distributed.serialization
- io.github.bucket4j.distributed.versioning - package io.github.bucket4j.distributed.versioning
- io.github.bucket4j.local - package io.github.bucket4j.local
- io.github.bucket4j.util - package io.github.bucket4j.util
- io.github.bucket4j.util.concurrent.batch - package io.github.bucket4j.util.concurrent.batch
- isAsyncModeSupported() - Method in class io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.AbstractLockBasedProxyManager
- isAsyncModeSupported() - Method in class io.github.bucket4j.distributed.proxy.generic.select_for_update.AbstractSelectForUpdateBasedProxyManager
- isAsyncModeSupported() - Method in interface io.github.bucket4j.distributed.proxy.ProxyManager
-
Describes whether or not this manager supports asynchronous API.
- isBucketNotFound() - Method in class io.github.bucket4j.distributed.remote.CommandResult
- isConfigurationNeedToBeReplaced() - Method in class io.github.bucket4j.distributed.remote.CommandResult
- isConsumed() - Method in class io.github.bucket4j.ConsumptionProbe
-
Flag describes result of consumption operation.
- isError() - Method in class io.github.bucket4j.distributed.remote.CommandResult
- isGready() - Method in class io.github.bucket4j.Bandwidth
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.AddTokensCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.CreateSnapshotCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.EstimateAbilityToConsumeCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.ForceAddTokensCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.GetAvailableTokensCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.GetConfigurationCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.ResetCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.SyncCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- isImmediateSyncRequired(long, long) - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- isImmediateSyncRequired(long, long) - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- isInitializationCommand() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- isInitializationCommand() - Method in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- isInitializationCommand() - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- isInitializationCommand() - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- isIntervallyAligned() - Method in class io.github.bucket4j.Bandwidth
- isLocked() - Method in class io.github.bucket4j.distributed.proxy.generic.select_for_update.LockAndGetResult
- isMerged() - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- isMerged() - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- isMerged() - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- isMerged() - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- isMerged() - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- isNeedToExecuteRemoteImmediately(long) - Method in class io.github.bucket4j.distributed.proxy.optimization.predictive.Sampling
- isRefillIntervally() - Method in class io.github.bucket4j.Bandwidth
- isStateModified() - Method in class io.github.bucket4j.distributed.remote.MutableBucketEntry
- isUseAdaptiveInitialTokens() - Method in class io.github.bucket4j.Bandwidth
- isWallClockBased() - Method in interface io.github.bucket4j.TimeMeter
-
Returns
trueif implementation of clock behaves the similar way asSystem.currentTimeMillis(), in other words if implementation can be used as wall clock.
L
- LimitChecker - Class in io.github.bucket4j
- LimitChecker() - Constructor for class io.github.bucket4j.LimitChecker
- LocalBucket - Interface in io.github.bucket4j.local
-
Represents the bucket inside current JVM.
- LocalBucketBuilder - Class in io.github.bucket4j.local
-
This builder creates in-memory buckets (
LockFreeBucket). - LocalBucketBuilder() - Constructor for class io.github.bucket4j.local.LocalBucketBuilder
- LocalBucketSerializationHelper - Class in io.github.bucket4j.local
- LocalBucketSerializationHelper() - Constructor for class io.github.bucket4j.local.LocalBucketSerializationHelper
- LOCK_FREE - io.github.bucket4j.local.SynchronizationStrategy
-
Lock-free algorithm based on CAS(compare and swap) of immutable objects.
- lockAndGet(Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.LockBasedTransaction
-
Locks data by the key associated with this transaction and returns data that is associated with the key.
- LockAndGetResult - Class in io.github.bucket4j.distributed.proxy.generic.select_for_update
- LockBasedTransaction - Interface in io.github.bucket4j.distributed.proxy.generic.pessimistic_locking
-
Describes the set of operations that
AbstractLockBasedProxyManagertypically performs in reaction to user request. - locked(byte[]) - Static method in class io.github.bucket4j.distributed.proxy.generic.select_for_update.LockAndGetResult
- LockFreeBucket - Class in io.github.bucket4j.local
- LockFreeBucket(BucketConfiguration, MathType, TimeMeter) - Constructor for class io.github.bucket4j.local.LockFreeBucket
- LONG - Static variable in interface io.github.bucket4j.distributed.jdbc.PrimaryKeyMapper
- LONG - Static variable in interface io.github.bucket4j.distributed.serialization.Mapper
- LONG_HANDLE - Static variable in class io.github.bucket4j.distributed.serialization.PrimitiveSerializationHandles
M
- ManuallySyncingOptimization - Class in io.github.bucket4j.distributed.proxy.optimization.manual
-
Optimization that can serve requests locally without synchronization with external storage until explicit call of
OptimizationController.syncImmediately(). - ManuallySyncingOptimization() - Constructor for class io.github.bucket4j.distributed.proxy.optimization.manual.ManuallySyncingOptimization
- ManuallySyncingOptimization(OptimizationListener, TimeMeter) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.manual.ManuallySyncingOptimization
- map(Function<T, R>) - Method in class io.github.bucket4j.distributed.remote.RemoteVerboseResult
- map(Function<T, R>) - Method in class io.github.bucket4j.VerboseResult
- Mapper<T> - Interface in io.github.bucket4j.distributed.serialization
- MathType - Enum in io.github.bucket4j
- max(Version, Version) - Static method in enum io.github.bucket4j.distributed.versioning.Versions
- max(Version, Version, Version) - Static method in enum io.github.bucket4j.distributed.versioning.Versions
- MAX_VALUE - Static variable in class io.github.bucket4j.distributed.remote.CommandResult
- maxSamples - Variable in class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
- maxSamplesForPredictionParametersCanNotBeLessThanMinSamples(int, int) - Static method in class io.github.bucket4j.BucketExceptions
- maxUnsynchronizedTimeoutNanos - Variable in class io.github.bucket4j.distributed.proxy.optimization.DelayParameters
- maxUnsynchronizedTokens - Variable in class io.github.bucket4j.distributed.proxy.optimization.DelayParameters
- merge(SerializationHandle<?>...) - Method in class io.github.bucket4j.distributed.serialization.SerializationHandles
- merge(List<RemoteCommand<?>>) - Static method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- mergeInto(RemoteCommand<?>) - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- mergeInto(RemoteCommand<?>) - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- mergeInto(RemoteCommand<?>) - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- mergeInto(RemoteCommand<?>) - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- MERGING_THRESHOLD - Static variable in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- minSamples - Variable in class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
- MultiCommand - Class in io.github.bucket4j.distributed.remote.commands
- MultiCommand(List<RemoteCommand<?>>) - Constructor for class io.github.bucket4j.distributed.remote.commands.MultiCommand
- MultiResult - Class in io.github.bucket4j.distributed.remote
- MultiResult(List<CommandResult<?>>) - Constructor for class io.github.bucket4j.distributed.remote.MultiResult
- MutableBucketEntry - Class in io.github.bucket4j.distributed.remote
- MutableBucketEntry(byte[]) - Constructor for class io.github.bucket4j.distributed.remote.MutableBucketEntry
- MutableBucketEntry(RemoteBucketState) - Constructor for class io.github.bucket4j.distributed.remote.MutableBucketEntry
N
- NO_TIMEOUT - Static variable in interface io.github.bucket4j.distributed.proxy.Timeout
- none() - Static method in interface io.github.bucket4j.distributed.ExpirationAfterWriteStrategy
-
Returns strategy that makes to store buckets forever.
- NONE - io.github.bucket4j.local.SynchronizationStrategy
-
This is fake strategy which does not perform synchronization at all.
- NONE_OPTIMIZED - Static variable in interface io.github.bucket4j.distributed.proxy.optimization.Optimization
- nonPositiveCapacity(long) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveFixedRefillInterval(Duration) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveInitialTokens(long) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveLimitToSync(long) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveMaxTimeoutBetweenSynchronizationForDelayParameters(Duration) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveNanosToWait(long) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositivePeriod(long) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositivePeriodTokens(long) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveRequestTimeout(Duration) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveSampleMaxAgeForPredictionParameters(long) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveTimeOfFirstRefill(Instant) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveTokensForDelayParameters(long) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveTokensLimitToSync(long) - Static method in class io.github.bucket4j.BucketExceptions
- nonPositiveTokensToConsume(long) - Static method in class io.github.bucket4j.BucketExceptions
- NOPE - Static variable in interface io.github.bucket4j.BucketListener
-
The default listener that do nothing.
- NopeOptimizationListener - Class in io.github.bucket4j.distributed.proxy.optimization
- NopeOptimizationListener() - Constructor for class io.github.bucket4j.distributed.proxy.optimization.NopeOptimizationListener
- Nothing - Class in io.github.bucket4j
- Nothing() - Constructor for class io.github.bucket4j.Nothing
- NOTHING - Static variable in class io.github.bucket4j.distributed.remote.CommandResult
- notLocked() - Static method in class io.github.bucket4j.distributed.proxy.generic.select_for_update.LockAndGetResult
- notSpecifiedTimeout() - Static method in interface io.github.bucket4j.distributed.proxy.Timeout
- NULL_HANDLE - Static variable in class io.github.bucket4j.distributed.serialization.PrimitiveSerializationHandles
- nullBandwidth() - Static method in class io.github.bucket4j.BucketExceptions
- nullBandwidthRefill() - Static method in class io.github.bucket4j.BucketExceptions
- nullBuilder() - Static method in class io.github.bucket4j.BucketExceptions
- nullConfiguration() - Static method in class io.github.bucket4j.BucketExceptions
- nullConfigurationFuture() - Static method in class io.github.bucket4j.BucketExceptions
- nullConfigurationSupplier() - Static method in class io.github.bucket4j.BucketExceptions
- nullFixedRefillInterval() - Static method in class io.github.bucket4j.BucketExceptions
- nullListener() - Static method in class io.github.bucket4j.BucketExceptions
- nullMaxTimeoutBetweenSynchronizationForDelayParameters() - Static method in class io.github.bucket4j.BucketExceptions
- nullRefillPeriod() - Static method in class io.github.bucket4j.BucketExceptions
- nullScheduler() - Static method in class io.github.bucket4j.BucketExceptions
- nullSynchronizationStrategy() - Static method in class io.github.bucket4j.BucketExceptions
- nullTimeMeter() - Static method in class io.github.bucket4j.BucketExceptions
- nullTokensInheritanceStrategy() - Static method in class io.github.bucket4j.BucketExceptions
O
- of(long, Duration) - Static method in class io.github.bucket4j.Refill
-
Deprecated.
- of(ClientSideConfig) - Static method in interface io.github.bucket4j.distributed.proxy.Timeout
- onConsumed(long) - Method in interface io.github.bucket4j.BucketListener
-
This method is called whenever
tokensis consumed. - onConsumed(long) - Method in class io.github.bucket4j.SimpleBucketListener
- onDelayed(long) - Method in interface io.github.bucket4j.BucketListener
-
This method is called each time when delayed task was submit to
ScheduledExecutorServicebecause of wait for tokens refill in result of interaction withSchedulingBucket - onDelayed(long) - Method in class io.github.bucket4j.SimpleBucketListener
- onInterrupted(InterruptedException) - Method in interface io.github.bucket4j.BucketListener
-
This method is called each time when thread was interrupted during the wait of tokens refill in result of interaction with
BlockingBucket - onInterrupted(InterruptedException) - Method in class io.github.bucket4j.SimpleBucketListener
- onParked(long) - Method in interface io.github.bucket4j.BucketListener
-
This method is called each time when thread was parked for wait of tokens refill in result of interaction with
BlockingBucket - onParked(long) - Method in class io.github.bucket4j.SimpleBucketListener
- onRejected(long) - Method in interface io.github.bucket4j.BucketListener
-
This method is called whenever consumption request for
tokensis rejected. - onRejected(long) - Method in class io.github.bucket4j.SimpleBucketListener
- Optimization - Interface in io.github.bucket4j.distributed.proxy.optimization
-
Specifies request optimization strategy for
BucketProxyandAsyncBucketProxy. - OptimizationController - Interface in io.github.bucket4j.distributed
-
The optimization controller for
BucketProxy. - OptimizationListener - Interface in io.github.bucket4j.distributed.proxy.optimization
-
Monitoring listener for applied optimizations
- Optimizations - Class in io.github.bucket4j.distributed.proxy.optimization
-
Provides factory methods for all request optimizations that are built-in into Bucket4j library.
- Optimizations() - Constructor for class io.github.bucket4j.distributed.proxy.optimization.Optimizations
P
- park(long) - Method in interface io.github.bucket4j.BlockingStrategy
-
Park current thread to required duration of nanoseconds.
- PARKING - Static variable in interface io.github.bucket4j.BlockingStrategy
- PARKING - Static variable in interface io.github.bucket4j.UninterruptibleBlockingStrategy
- parkUninterruptibly(long) - Method in interface io.github.bucket4j.UninterruptibleBlockingStrategy
-
Parks current thread to required duration of nanoseconds ignoring all interrupts, if interrupt was happen then interruption flag will be restored on the current thread.
- PERSISTED_STATE - io.github.bucket4j.distributed.serialization.Scope
- predictedConsumptionByOthersSinceLastSync(long) - Method in class io.github.bucket4j.distributed.proxy.optimization.predictive.Sampling
- predicting(DelayParameters) - Static method in class io.github.bucket4j.distributed.proxy.optimization.Optimizations
-
Has the same semantic as
Optimizations.predicting(DelayParameters, PredictionParameters)but uses defaultPredictionParameters. - predicting(DelayParameters, PredictionParameters) - Static method in class io.github.bucket4j.distributed.proxy.optimization.Optimizations
-
Creates optimization that can serve requests locally without synchronization with external storage until thresholds are not violated, and additionally tries to predict aggregated consumption rate in whole cluster in order to reduce the risk of overconsumption that caused by
DelayOptimization. - PredictionParameters - Class in io.github.bucket4j.distributed.proxy.optimization
-
Specifies the parameters for quality of distributes consumption rate prediction that are used by
PredictiveOptimization - PredictionParameters(int, int, long) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
- PredictionParameters(int, int, Duration) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
-
Creates new instance of
PredictionParameters - PredictiveOptimization - Class in io.github.bucket4j.distributed.proxy.optimization.predictive
-
Optimization that can serve requests locally without synchronization with external storage until thresholds are not violated.
- PredictiveOptimization(PredictionParameters, DelayParameters, OptimizationListener, TimeMeter) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.predictive.PredictiveOptimization
- PrimaryKeyMapper<T> - Interface in io.github.bucket4j.distributed.jdbc
- primitiveHandlesById - Static variable in class io.github.bucket4j.distributed.serialization.PrimitiveSerializationHandles
- PrimitiveSerializationHandles - Class in io.github.bucket4j.distributed.serialization
- PrimitiveSerializationHandles() - Constructor for class io.github.bucket4j.distributed.serialization.PrimitiveSerializationHandles
- PROPORTIONALLY - io.github.bucket4j.TokensInheritanceStrategy
-
Makes to copy available tokens proportional to bandwidth capacity by following formula:
newAvailableTokens = availableTokensBeforeReplacement * (newBandwidthCapacity / capacityBeforeReplacement) - ProxyManager<K> - Interface in io.github.bucket4j.distributed.proxy
-
Represents an extension point of bucket4j library.
R
- readBoolean(DataInput) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- readBoolean(S) - Method in interface io.github.bucket4j.distributed.serialization.DeserializationAdapter
- readByte(DataInput) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- readByte(S) - Method in interface io.github.bucket4j.distributed.serialization.DeserializationAdapter
- readDoubleArray(DataInput) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- readDoubleArray(Map<String, Object>, String) - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- readDoubleArray(S) - Method in interface io.github.bucket4j.distributed.serialization.DeserializationAdapter
- readInt(DataInput) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- readInt(S) - Method in interface io.github.bucket4j.distributed.serialization.DeserializationAdapter
- readIntValue(Map<String, Object>, String) - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- readLong(DataInput) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- readLong(S) - Method in interface io.github.bucket4j.distributed.serialization.DeserializationAdapter
- readLongArray(DataInput) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- readLongArray(Map<String, Object>, String) - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- readLongArray(S) - Method in interface io.github.bucket4j.distributed.serialization.DeserializationAdapter
- readLongValue(Map<String, Object>, String) - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- readOptionalIntValue(Map<String, Object>, String) - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- readOptionalLongValue(Map<String, Object>, String) - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- readString(DataInput) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- readString(S) - Method in interface io.github.bucket4j.distributed.serialization.DeserializationAdapter
- RECONSTRUCT - io.github.bucket4j.distributed.proxy.RecoveryStrategy
-
Initialize bucket yet another time.
- RecoveryStrategy - Enum in io.github.bucket4j.distributed.proxy
-
Specifies the reaction which should be applied in case of previously saved state of bucket has been lost.
- Refill - Class in io.github.bucket4j
-
Deprecated.
- refillAllBandwidth(long) - Method in interface io.github.bucket4j.BucketState
- refillAllBandwidth(long) - Method in class io.github.bucket4j.BucketState64BitsInteger
- refillAllBandwidth(long) - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- refillGreedy(long, Duration) - Method in interface io.github.bucket4j.BandwidthBuilder.BandwidthBuilderRefillStage
-
Configures refill that does refill of tokens in greedy manner, it will try to add the tokens to bucket as soon as possible.
- refillIntervally(long, Duration) - Method in interface io.github.bucket4j.BandwidthBuilder.BandwidthBuilderRefillStage
-
Configures refill that does refill of tokens in intervally manner.
- refillIntervallyAligned(long, Duration, Instant) - Method in interface io.github.bucket4j.BandwidthBuilder.BandwidthBuilderRefillStage
-
Configures refill that does refill of tokens in intervally manner.
- refillIntervallyAlignedWithAdaptiveInitialTokens(long, Duration, Instant) - Method in interface io.github.bucket4j.BandwidthBuilder.BandwidthBuilderRefillStage
-
Configures refill that does refill of tokens in intervally manner.
- rejected(long, long, long) - Static method in class io.github.bucket4j.ConsumptionProbe
- release() - Method in interface io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.LockBasedTransaction
-
Frees resources associated with this transaction
- release() - Method in interface io.github.bucket4j.distributed.proxy.generic.select_for_update.SelectForUpdateBasedTransaction
-
Frees resources associated with this transaction
- rememberRemoteCommandResult(long, long, long) - Method in class io.github.bucket4j.distributed.proxy.optimization.predictive.Sampling
- RemoteAsyncBucketBuilder<K> - Interface in io.github.bucket4j.distributed.proxy
-
The builder for
AsyncBucketProxy - RemoteBucketBuilder<K> - Interface in io.github.bucket4j.distributed.proxy
-
The builder for
BucketProxy - RemoteBucketState - Class in io.github.bucket4j.distributed.remote
- RemoteBucketState(BucketState, RemoteStat, Long) - Constructor for class io.github.bucket4j.distributed.remote.RemoteBucketState
- RemoteCommand<T> - Interface in io.github.bucket4j.distributed.remote
- RemoteStat - Class in io.github.bucket4j.distributed.remote
- RemoteStat(long) - Constructor for class io.github.bucket4j.distributed.remote.RemoteStat
- RemoteVerboseResult<T> - Class in io.github.bucket4j.distributed.remote
-
Intention of this class is to provide wrapper around results returned by any method of
VerboseBucketandAsyncVerboseBucket. - RemoteVerboseResult(long, int, T, RemoteBucketState) - Constructor for class io.github.bucket4j.distributed.remote.RemoteVerboseResult
- removeAsync(Object) - Method in class io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.AbstractLockBasedProxyManager
- removeAsync(Object) - Method in class io.github.bucket4j.distributed.proxy.generic.select_for_update.AbstractSelectForUpdateBasedProxyManager
- removeAsync(K) - Method in class io.github.bucket4j.distributed.proxy.AbstractProxyManager
- removeProxy(K) - Method in interface io.github.bucket4j.distributed.proxy.AsyncProxyManager
-
Asynchronously removes persisted state of bucket from underlying storage.
- removeProxy(K) - Method in interface io.github.bucket4j.distributed.proxy.ProxyManager
-
Removes persisted state of bucket from underlying storage.
- replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.AbstractBucket
- replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) - Method in interface io.github.bucket4j.Bucket
-
Replaces configuration of this bucket.
- replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Has the same semantic with
Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) - replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) - replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy) - replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy, long) - Method in interface io.github.bucket4j.BucketState
- replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy, long) - Method in class io.github.bucket4j.BucketState64BitsInteger
- replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy, long) - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- ReplaceConfigurationCommand - Class in io.github.bucket4j.distributed.remote.commands
- ReplaceConfigurationCommand(BucketConfiguration, TokensInheritanceStrategy) - Constructor for class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- replaceConfigurationImpl(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.AbstractBucket
- replaceConfigurationImpl(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- replaceConfigurationImpl(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.local.LockFreeBucket
- replaceConfigurationImpl(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.local.SynchronizedBucket
- replaceConfigurationImpl(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- replaceConfigurationVerboseImpl(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.AbstractBucket
- replaceConfigurationVerboseImpl(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- replaceConfigurationVerboseImpl(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.local.LockFreeBucket
- replaceConfigurationVerboseImpl(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.local.SynchronizedBucket
- replaceConfigurationVerboseImpl(BucketConfiguration, TokensInheritanceStrategy) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- Request<T> - Class in io.github.bucket4j.distributed.remote
- Request(RemoteCommand<T>, Version, Long) - Constructor for class io.github.bucket4j.distributed.remote.Request
- REQUEST - io.github.bucket4j.distributed.serialization.Scope
- reservationOverflow() - Static method in class io.github.bucket4j.BucketExceptions
- ReserveAndCalculateTimeToSleepCommand - Class in io.github.bucket4j.distributed.remote.commands
- ReserveAndCalculateTimeToSleepCommand(long, long) - Constructor for class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- reserveAndCalculateTimeToSleepImpl(long, long) - Method in class io.github.bucket4j.AbstractBucket
- reserveAndCalculateTimeToSleepImpl(long, long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- reserveAndCalculateTimeToSleepImpl(long, long) - Method in class io.github.bucket4j.local.LockFreeBucket
- reserveAndCalculateTimeToSleepImpl(long, long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- reserveAndCalculateTimeToSleepImpl(long, long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- reset() - Method in interface io.github.bucket4j.Bucket
-
Reset all tokens up to maximum capacity.
- reset() - Method in interface io.github.bucket4j.BucketState
- reset() - Method in class io.github.bucket4j.BucketState64BitsInteger
- reset() - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Reset all tokens up to maximum capacity.
- reset() - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- reset() - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.reset() - reset() - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- reset() - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- reset() - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- reset() - Method in class io.github.bucket4j.local.LockFreeBucket
- reset() - Method in class io.github.bucket4j.local.SynchronizedBucket
- reset() - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- reset() - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.reset() - RESET - io.github.bucket4j.TokensInheritanceStrategy
-
Use this mode when you want just to forget about previous bucket state.
- ResetCommand - Class in io.github.bucket4j.distributed.remote.commands
- ResetCommand() - Constructor for class io.github.bucket4j.distributed.remote.commands.ResetCommand
- resetVerboseImpl() - Method in class io.github.bucket4j.AbstractBucket
- resetVerboseImpl() - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- resetVerboseImpl() - Method in class io.github.bucket4j.local.LockFreeBucket
- resetVerboseImpl() - Method in class io.github.bucket4j.local.SynchronizedBucket
- resetVerboseImpl() - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- RESPONSE - io.github.bucket4j.distributed.serialization.Scope
- restrictionsNotSpecified() - Static method in class io.github.bucket4j.BucketExceptions
- rollback() - Method in interface io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.LockBasedTransaction
-
Rollbacks transaction if underlying storage requires transactions
- rollback() - Method in interface io.github.bucket4j.distributed.proxy.generic.select_for_update.SelectForUpdateBasedTransaction
-
Rollbacks transaction if underlying storage requires transactions
- run(Consumer<Optional<Long>>) - Method in interface io.github.bucket4j.distributed.proxy.Timeout
S
- SAME_TREAD - Static variable in interface io.github.bucket4j.distributed.proxy.ExecutionStrategy
-
This execution strategy always communicates with backend in current thread
- sampleMaxAgeNanos - Variable in class io.github.bucket4j.distributed.proxy.optimization.PredictionParameters
- Sampling - Class in io.github.bucket4j.distributed.proxy.optimization.predictive
- Sampling(PredictionParameters) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.predictive.Sampling
- SchedulingBucket - Interface in io.github.bucket4j
-
Provides the scheduling API for
Bucket. - Scope - Enum in io.github.bucket4j.distributed.serialization
- SelectForUpdateBasedTransaction - Interface in io.github.bucket4j.distributed.proxy.generic.select_for_update
-
Describes the set of operations that
AbstractSelectForUpdateBasedProxyManagertypically performs in reaction to user request. - SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.Bandwidth
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.BucketConfiguration
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.BucketState64BitsInteger
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.ConsumptionProbe
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.BucketNotFoundError
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.CommandResult
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.AddTokensCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateAndExecuteCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.CreateInitialStateWithVersionOrReplaceConfigurationAndExecuteCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.CreateSnapshotCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.EstimateAbilityToConsumeCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.ForceAddTokensCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.GetAvailableTokensCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.GetConfigurationCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.ReplaceConfigurationCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.ReserveAndCalculateTimeToSleepCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.ResetCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.SyncCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.ConfigurationNeedToBeReplacedError
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.MultiResult
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.RemoteBucketState
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.RemoteStat
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.RemoteVerboseResult
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.Request
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.UnsupportedNamedTypeError
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.UnsupportedTypeError
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.UsageOfObsoleteApiError
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.distributed.remote.UsageOfUnsupportedApiError
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.EstimationProbe
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.local.LockFreeBucket
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.local.SynchronizedBucket
- SERIALIZATION_HANDLE - Static variable in class io.github.bucket4j.local.ThreadUnsafeBucket
- SerializationAdapter<T> - Interface in io.github.bucket4j.distributed.serialization
- SerializationHandle<T> - Interface in io.github.bucket4j.distributed.serialization
- SerializationHandles - Class in io.github.bucket4j.distributed.serialization
- SerializationHandles(Collection<SerializationHandle<?>>) - Constructor for class io.github.bucket4j.distributed.serialization.SerializationHandles
- serialize(SerializationAdapter<O>, O, BucketState, Version, Scope) - Static method in interface io.github.bucket4j.BucketState
- serialize(SerializationAdapter<O>, O, RemoteCommand<?>, Version, Scope) - Static method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- serialize(SerializationAdapter<O>, O, T, Version, Scope) - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- serializeRequest(Request<?>) - Static method in class io.github.bucket4j.distributed.serialization.InternalSerializationHelper
- serializeResult(CommandResult<?>, Version) - Static method in class io.github.bucket4j.distributed.serialization.InternalSerializationHelper
- serializeState(RemoteBucketState, Version) - Static method in class io.github.bucket4j.distributed.serialization.InternalSerializationHelper
- set(RemoteBucketState) - Method in class io.github.bucket4j.distributed.remote.MutableBucketEntry
- set(PreparedStatement, int, T) - Method in interface io.github.bucket4j.distributed.jdbc.PrimaryKeyMapper
- setConfiguration(BucketConfiguration) - Method in interface io.github.bucket4j.BucketState
- setConfiguration(BucketConfiguration) - Method in class io.github.bucket4j.BucketState64BitsInteger
- setConfiguration(BucketConfiguration) - Method in class io.github.bucket4j.local.SynchronizedBucket
- setConfiguration(BucketConfiguration) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- setConfigurationVersion(Long) - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- setLimit(long) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- setMerged(boolean) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- setRawState(byte[]) - Method in class io.github.bucket4j.distributed.remote.AbstractBinaryTransaction
- simple(long, Duration) - Static method in class io.github.bucket4j.Bandwidth
-
Deprecated.
- SimpleBucketListener - Class in io.github.bucket4j
- SimpleBucketListener() - Constructor for class io.github.bucket4j.SimpleBucketListener
- SkipSyncOnZeroOptimization - Class in io.github.bucket4j.distributed.proxy.optimization.skiponzero
-
Optimization that can serve requests locally without synchronization with external storage when it detects that there is no tokens in remote storage, in such case synchronization with storage is being postponed to proposed refill of first token.
- SkipSyncOnZeroOptimization(OptimizationListener, TimeMeter) - Constructor for class io.github.bucket4j.distributed.proxy.optimization.skiponzero.SkipSyncOnZeroOptimization
- smooth(long, Duration) - Static method in class io.github.bucket4j.Refill
-
Deprecated.
- SQLProxyConfiguration<K> - Class in io.github.bucket4j.distributed.jdbc
- SQLProxyConfigurationBuilder<K> - Class in io.github.bucket4j.distributed.jdbc
- STRING - Static variable in interface io.github.bucket4j.distributed.jdbc.PrimaryKeyMapper
- STRING - Static variable in interface io.github.bucket4j.distributed.serialization.Mapper
- success(R, int) - Static method in class io.github.bucket4j.distributed.remote.CommandResult
- success(R, SerializationHandle) - Static method in class io.github.bucket4j.distributed.remote.CommandResult
- syncByCondition(long, Duration) - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- syncByCondition(long, Duration) - Method in interface io.github.bucket4j.distributed.AsyncOptimizationController
-
Initiates immediate synchronization of local copy of bucket with remote storage in case of both conditions bellow are
true: Accumulated amount of locally consumed tokens without external synchronization is greater than or equal tounsynchronizedTokensTime passed since last synchronization with external storage is greater than or equal totimeSinceLastSync - syncByCondition(long, Duration) - Method in interface io.github.bucket4j.distributed.OptimizationController
-
Initiates immediate synchronization of local copy of bucket with remote storage in case of both conditions bellow are
true: Accumulated amount of locally consumed tokens without external synchronization is greater than or equal tounsynchronizedTokensTime passed since last synchronization with external storage is greater than or equal totimeSinceLastSync - syncByCondition(long, Duration) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- syncByCondition(long, Duration) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- SyncCommand - Class in io.github.bucket4j.distributed.remote.commands
- SyncCommand(long, long) - Constructor for class io.github.bucket4j.distributed.remote.commands.SyncCommand
- SynchronizationStrategy - Enum in io.github.bucket4j.local
-
Defines the strategy of synchronization which need to be applied to prevent data-races in multithreading usage scenario.
- SYNCHRONIZED - io.github.bucket4j.local.SynchronizationStrategy
-
Blocking strategy based on java
synchronizedkeyword. - SynchronizedBucket - Class in io.github.bucket4j.local
- SynchronizedBucket(BucketConfiguration, MathType, TimeMeter) - Constructor for class io.github.bucket4j.local.SynchronizedBucket
- syncImmediately() - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- syncImmediately() - Method in interface io.github.bucket4j.distributed.AsyncOptimizationController
-
Initiates immediate synchronization of local copy of bucket with remote storage
- syncImmediately() - Method in interface io.github.bucket4j.distributed.OptimizationController
-
Initiates immediate synchronization of local copy of bucket with remote storage
- SYSTEM_MILLISECONDS - Static variable in interface io.github.bucket4j.TimeMeter
-
The implementation of
TimeMeterwhich works aroundSystem.currentTimeMillis() - SYSTEM_NANOTIME - Static variable in interface io.github.bucket4j.TimeMeter
-
The implementation of
TimeMeterwhich works aroundSystem.nanoTime()
T
- ThreadUnsafeBucket - Class in io.github.bucket4j.local
- ThreadUnsafeBucket(BucketConfiguration, MathType, TimeMeter) - Constructor for class io.github.bucket4j.local.ThreadUnsafeBucket
- THROW_BUCKET_NOT_FOUND_EXCEPTION - io.github.bucket4j.distributed.proxy.RecoveryStrategy
-
Throw
BucketNotFoundException. - TimeMeter - Interface in io.github.bucket4j
-
An abstraction over time measurement.
- Timeout - Interface in io.github.bucket4j.distributed.proxy
- TimeoutException - Exception in io.github.bucket4j
- TimeoutException(String, long, long) - Constructor for exception io.github.bucket4j.TimeoutException
- timeoutReached(long, long) - Static method in class io.github.bucket4j.BucketExceptions
- toBinarySnapshot() - Method in interface io.github.bucket4j.local.LocalBucket
-
Takes the binary snapshot of this bucket that later can be used as parameter for
LocalBucket.fromBinarySnapshot(byte[])to restore bucket from snapshot. - toBytes(T) - Method in interface io.github.bucket4j.distributed.serialization.Mapper
- toJsonCompatibleSnapshot() - Method in interface io.github.bucket4j.local.LocalBucket
-
Takes the JSON snapshot of this bucket that later can be used as parameter for
LocalBucket.fromJsonCompatibleSnapshot(Map)to restore bucket from snapshot. - toJsonCompatibleSnapshot(BucketState, Version, Scope) - Static method in interface io.github.bucket4j.BucketState
- toJsonCompatibleSnapshot(RemoteCommand<?>, Version, Scope) - Static method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- toJsonCompatibleSnapshot(T, Version, Scope) - Method in interface io.github.bucket4j.distributed.serialization.SerializationHandle
- TokensInheritanceStrategy - Enum in io.github.bucket4j
-
Specifies the rules for inheritance of available tokens when
Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)happens. - toListenable(BucketListener) - Method in interface io.github.bucket4j.Bucket
-
Returns new copy of this bucket instance decorated by
listener. - toListenable(BucketListener) - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Returns new copy of this bucket instance decorated by
listener. - toListenable(BucketListener) - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- toListenable(BucketListener) - Method in interface io.github.bucket4j.distributed.BucketProxy
- toListenable(BucketListener) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- toListenable(BucketListener) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- toListenable(BucketListener) - Method in class io.github.bucket4j.local.LockFreeBucket
- toListenable(BucketListener) - Method in class io.github.bucket4j.local.SynchronizedBucket
- toListenable(BucketListener) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- toMergedCommand() - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- toMergedCommand() - Method in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- toMergedCommand() - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- toMergedCommand() - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- tooHighRefillRate(long, long) - Static method in class io.github.bucket4j.BucketExceptions
- toString() - Method in class io.github.bucket4j.Bandwidth
- toString() - Method in class io.github.bucket4j.BucketConfiguration
- toString() - Method in class io.github.bucket4j.BucketState64BitsInteger
- toString() - Method in class io.github.bucket4j.ConfigurationBuilder
- toString() - Method in class io.github.bucket4j.ConsumptionProbe
- toString() - Method in class io.github.bucket4j.distributed.remote.RemoteBucketState
- toString() - Method in class io.github.bucket4j.EstimationProbe
- toString() - Method in class io.github.bucket4j.local.LockFreeBucket
- toString() - Method in class io.github.bucket4j.local.SynchronizedBucket
- toString() - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- toString() - Method in class io.github.bucket4j.Refill
-
Deprecated.
- toString(T) - Method in interface io.github.bucket4j.distributed.serialization.Mapper
- TRUE - Static variable in class io.github.bucket4j.distributed.remote.CommandResult
- TRY_CONSUME_ONE - Static variable in class io.github.bucket4j.distributed.remote.commands.TryConsumeCommand
- TRY_CONSUME_ONE_VERBOSE - Static variable in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- tryConsume(long) - Method in class io.github.bucket4j.AbstractBucket
- tryConsume(long) - Method in interface io.github.bucket4j.Bucket
-
Tries to consume a specified number of tokens from this bucket.
- tryConsume(long) - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Asynchronous version of
Bucket.tryConsume(long), follows the same semantic. - tryConsume(long) - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- tryConsume(long) - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.tryConsume(long) - tryConsume(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- tryConsume(long) - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.tryConsume(long) - tryConsume(long, long) - Method in interface io.github.bucket4j.BlockingBucket
-
This is just overloaded equivalent of
BlockingBucket.tryConsume(long, long, BlockingStrategy) - tryConsume(long, long, BlockingStrategy) - Method in class io.github.bucket4j.AbstractBucket
- tryConsume(long, long, BlockingStrategy) - Method in interface io.github.bucket4j.BlockingBucket
-
Tries to consume a specified number of tokens from the bucket.
- tryConsume(long, long, ScheduledExecutorService) - Method in class io.github.bucket4j.AbstractBucket
- tryConsume(long, long, ScheduledExecutorService) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- tryConsume(long, long, ScheduledExecutorService) - Method in interface io.github.bucket4j.SchedulingBucket
-
Tries to consume the specified number of tokens from the bucket.
- tryConsume(long, Duration) - Method in interface io.github.bucket4j.BlockingBucket
-
This is just overloaded equivalent of
BlockingBucket.tryConsume(long, long, BlockingStrategy) - tryConsume(long, Duration, BlockingStrategy) - Method in interface io.github.bucket4j.BlockingBucket
-
This is just overloaded equivalent of
BlockingBucket.tryConsume(long, long, BlockingStrategy) - tryConsume(long, Duration, ScheduledExecutorService) - Method in interface io.github.bucket4j.SchedulingBucket
-
This is just overloaded equivalent of
SchedulingBucket.tryConsume(long, long, ScheduledExecutorService) - tryConsumeAndReturnRemaining(long) - Method in class io.github.bucket4j.AbstractBucket
- tryConsumeAndReturnRemaining(long) - Method in interface io.github.bucket4j.Bucket
-
Tries to consume a specified number of tokens from this bucket.
- tryConsumeAndReturnRemaining(long) - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Asynchronous version of
Bucket.tryConsumeAndReturnRemaining(long), follows the same semantic. - tryConsumeAndReturnRemaining(long) - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- tryConsumeAndReturnRemaining(long) - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.tryConsumeAndReturnRemaining(long) - tryConsumeAndReturnRemaining(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- tryConsumeAndReturnRemaining(long) - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.tryConsumeAndReturnRemaining(long) - TryConsumeAndReturnRemainingTokensCommand - Class in io.github.bucket4j.distributed.remote.commands
- TryConsumeAndReturnRemainingTokensCommand(long) - Constructor for class io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand
- tryConsumeAndReturnRemainingTokensImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- tryConsumeAndReturnRemainingTokensImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- tryConsumeAndReturnRemainingTokensImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- tryConsumeAndReturnRemainingTokensImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- tryConsumeAndReturnRemainingTokensImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- tryConsumeAndReturnRemainingTokensVerboseImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- tryConsumeAndReturnRemainingTokensVerboseImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- tryConsumeAndReturnRemainingTokensVerboseImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- tryConsumeAndReturnRemainingTokensVerboseImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- tryConsumeAndReturnRemainingTokensVerboseImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- tryConsumeAsMuchAsPossible() - Method in class io.github.bucket4j.AbstractBucket
- tryConsumeAsMuchAsPossible() - Method in interface io.github.bucket4j.Bucket
-
Tries to consume as much tokens from this bucket as available at the moment of invocation.
- tryConsumeAsMuchAsPossible() - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Asynchronous version of
Bucket.tryConsumeAsMuchAsPossible(), follows the same semantic. - tryConsumeAsMuchAsPossible() - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- tryConsumeAsMuchAsPossible() - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.tryConsumeAsMuchAsPossible() - tryConsumeAsMuchAsPossible() - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- tryConsumeAsMuchAsPossible() - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.tryConsumeAsMuchAsPossible() - tryConsumeAsMuchAsPossible(long) - Method in class io.github.bucket4j.AbstractBucket
- tryConsumeAsMuchAsPossible(long) - Method in interface io.github.bucket4j.Bucket
-
Tries to consume as much tokens from bucket as available in the bucket at the moment of invocation, but tokens which should be consumed is limited by
limit. - tryConsumeAsMuchAsPossible(long) - Method in interface io.github.bucket4j.distributed.AsyncBucketProxy
-
Asynchronous version of
Bucket.tryConsumeAsMuchAsPossible(long), follows the same semantic. - tryConsumeAsMuchAsPossible(long) - Method in class io.github.bucket4j.distributed.AsyncBucketProxyAdapter
- tryConsumeAsMuchAsPossible(long) - Method in interface io.github.bucket4j.distributed.AsyncVerboseBucket
-
Does the same that
Bucket.tryConsumeAsMuchAsPossible(long) - tryConsumeAsMuchAsPossible(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultAsyncBucketProxy
- tryConsumeAsMuchAsPossible(long) - Method in interface io.github.bucket4j.VerboseBucket
-
Does the same that
Bucket.tryConsumeAsMuchAsPossible(long) - TryConsumeCommand - Class in io.github.bucket4j.distributed.remote.commands
- tryConsumeImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- tryConsumeImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- tryConsumeImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- tryConsumeImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- tryConsumeImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- tryConsumeUninterruptibly(long, long) - Method in interface io.github.bucket4j.BlockingBucket
-
This is just overloaded equivalent of
BlockingBucket.tryConsumeUninterruptibly(long, long, UninterruptibleBlockingStrategy) - tryConsumeUninterruptibly(long, long, UninterruptibleBlockingStrategy) - Method in class io.github.bucket4j.AbstractBucket
- tryConsumeUninterruptibly(long, long, UninterruptibleBlockingStrategy) - Method in interface io.github.bucket4j.BlockingBucket
-
Has same semantic with
BlockingBucket.tryConsume(long, long, BlockingStrategy)but ignores interrupts(just restores interruption flag on exit). - tryConsumeUninterruptibly(long, Duration) - Method in interface io.github.bucket4j.BlockingBucket
-
This is just overloaded equivalent of
BlockingBucket.tryConsumeUninterruptibly(long, long, UninterruptibleBlockingStrategy) - tryConsumeUninterruptibly(long, Duration, UninterruptibleBlockingStrategy) - Method in interface io.github.bucket4j.BlockingBucket
-
This is just overloaded equivalent of
BlockingBucket.tryConsumeUninterruptibly(long, long, UninterruptibleBlockingStrategy) - tryConsumeVerboseImpl(long) - Method in class io.github.bucket4j.AbstractBucket
- tryConsumeVerboseImpl(long) - Method in class io.github.bucket4j.distributed.proxy.DefaultBucketProxy
- tryConsumeVerboseImpl(long) - Method in class io.github.bucket4j.local.LockFreeBucket
- tryConsumeVerboseImpl(long) - Method in class io.github.bucket4j.local.SynchronizedBucket
- tryConsumeVerboseImpl(long) - Method in class io.github.bucket4j.local.ThreadUnsafeBucket
- tryInsertEmptyData(Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.select_for_update.SelectForUpdateBasedTransaction
-
Creates empty data by for the key associated with this transaction.
- tryLockAndGet(Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.select_for_update.SelectForUpdateBasedTransaction
-
Locks data by the key associated with this transaction and returns data that is associated with the key.
U
- UNDEFINED_ID - Static variable in class io.github.bucket4j.Bandwidth
- UninterruptibleBlockingStrategy - Interface in io.github.bucket4j
-
Specifies the way to block current thread to amount of time required to refill missed number of tokens in the bucket.
- UnknownVersion(int) - Constructor for class io.github.bucket4j.distributed.versioning.Versions.UnknownVersion
- UNLIMITED_AMOUNT - Static variable in class io.github.bucket4j.AbstractBucket
- UNLIMITED_AMOUNT - Static variable in class io.github.bucket4j.LimitChecker
- unlock() - Method in interface io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.LockBasedTransaction
-
Unlocks data by the key associated with this transaction.
- UNSPECIFIED_TIME_OF_FIRST_REFILL - Static variable in class io.github.bucket4j.Bandwidth
- unsupportedNamedType(String) - Static method in class io.github.bucket4j.distributed.remote.CommandResult
- UnsupportedNamedTypeError - Class in io.github.bucket4j.distributed.remote
- UnsupportedNamedTypeError(String) - Constructor for class io.github.bucket4j.distributed.remote.UnsupportedNamedTypeError
- UnsupportedNamedTypeException - Exception in io.github.bucket4j.distributed.versioning
- UnsupportedNamedTypeException(String) - Constructor for exception io.github.bucket4j.distributed.versioning.UnsupportedNamedTypeException
- unsupportedType(int) - Static method in class io.github.bucket4j.distributed.remote.CommandResult
- UnsupportedTypeError - Class in io.github.bucket4j.distributed.remote
- UnsupportedTypeError(int) - Constructor for class io.github.bucket4j.distributed.remote.UnsupportedTypeError
- UnsupportedTypeException - Exception in io.github.bucket4j.distributed.versioning
- UnsupportedTypeException(int) - Constructor for exception io.github.bucket4j.distributed.versioning.UnsupportedTypeException
- unwrap(CommandResult<MultiResult>) - Method in class io.github.bucket4j.distributed.remote.commands.MultiCommand
- unwrapOneResult(RemoteVerboseResult<T>, int) - Method in class io.github.bucket4j.distributed.remote.commands.VerboseCommand
- unwrapOneResult(Long, int) - Method in class io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand
- unwrapOneResult(T, int) - Method in class io.github.bucket4j.distributed.remote.commands.CheckConfigurationVersionAndExecuteCommand
- unwrapOneResult(T, int) - Method in interface io.github.bucket4j.distributed.remote.RemoteCommand
- update(byte[], RemoteBucketState, Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.LockBasedTransaction
-
Updates the data by the key associated with this transaction.
- update(byte[], RemoteBucketState, Optional<Long>) - Method in interface io.github.bucket4j.distributed.proxy.generic.select_for_update.SelectForUpdateBasedTransaction
-
Updates the data by the key associated with this transaction.
- UsageOfObsoleteApiError - Class in io.github.bucket4j.distributed.remote
- UsageOfObsoleteApiError(int, int) - Constructor for class io.github.bucket4j.distributed.remote.UsageOfObsoleteApiError
- usageOfObsoleteApiException(int, int) - Static method in class io.github.bucket4j.distributed.remote.CommandResult
- UsageOfObsoleteApiException - Exception in io.github.bucket4j.distributed.versioning
- UsageOfObsoleteApiException(int, int) - Constructor for exception io.github.bucket4j.distributed.versioning.UsageOfObsoleteApiException
- UsageOfUnsupportedApiError - Class in io.github.bucket4j.distributed.remote
- UsageOfUnsupportedApiError(int, int) - Constructor for class io.github.bucket4j.distributed.remote.UsageOfUnsupportedApiError
- usageOfUnsupportedApiException(int, int) - Static method in class io.github.bucket4j.distributed.remote.CommandResult
- UsageOfUnsupportedApiException - Exception in io.github.bucket4j.distributed.versioning
- UsageOfUnsupportedApiException(int, int) - Constructor for exception io.github.bucket4j.distributed.versioning.UsageOfUnsupportedApiException
V
- v_7_0_0 - io.github.bucket4j.distributed.versioning.Versions
- v_8_1_0 - io.github.bucket4j.distributed.versioning.Versions
- valueOf(String) - Static method in enum io.github.bucket4j.distributed.proxy.RecoveryStrategy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.github.bucket4j.distributed.serialization.Scope
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.github.bucket4j.distributed.versioning.Versions
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.github.bucket4j.local.SynchronizationStrategy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.github.bucket4j.MathType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.github.bucket4j.TokensInheritanceStrategy
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.github.bucket4j.distributed.proxy.RecoveryStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.github.bucket4j.distributed.serialization.Scope
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.github.bucket4j.distributed.versioning.Versions
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.github.bucket4j.local.SynchronizationStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.github.bucket4j.MathType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.github.bucket4j.TokensInheritanceStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VerboseBucket - Interface in io.github.bucket4j
-
Intent of this interface is to provide the verbose version of
BucketAPI. - VerboseCommand<T> - Class in io.github.bucket4j.distributed.remote.commands
- VerboseResult<T> - Class in io.github.bucket4j
-
Intention of this class is to provide wrapper around results returned by any method of
VerboseBucketandAsyncVerboseBucket. - VerboseResult(long, T, BucketState) - Constructor for class io.github.bucket4j.VerboseResult
- VerboseResult.Diagnostics - Interface in io.github.bucket4j
-
Describer of internal bucket state
- Version - Interface in io.github.bucket4j.distributed.versioning
- Versions - Enum in io.github.bucket4j.distributed.versioning
- Versions.UnknownVersion - Class in io.github.bucket4j.distributed.versioning
W
- withClientClock(TimeMeter) - Method in class io.github.bucket4j.distributed.proxy.ClientSideConfig
-
Returns new instance of
ClientSideConfigwith configuredclientClock. - withClientSideConfig(ClientSideConfig) - Method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfigurationBuilder
- withCustomTimePrecision(TimeMeter) - Method in class io.github.bucket4j.local.LocalBucketBuilder
-
Specifies
customTimeMetertime meter for buckets that will be created by this builder. - withExecutionStrategy(ExecutionStrategy) - Method in class io.github.bucket4j.distributed.proxy.ClientSideConfig
-
Returns new instance of
ClientSideConfigwith configuredexecutionStrategy. - withId(String) - Method in class io.github.bucket4j.Bandwidth
-
Deprecated.
- withImplicitConfigurationReplacement(long, TokensInheritanceStrategy) - Method in interface io.github.bucket4j.distributed.proxy.RemoteAsyncBucketBuilder
-
Activates implicit configuration replacement.
- withImplicitConfigurationReplacement(long, TokensInheritanceStrategy) - Method in interface io.github.bucket4j.distributed.proxy.RemoteBucketBuilder
-
Activates implicit configuration replacement.
- withInitialTokens(long) - Method in class io.github.bucket4j.Bandwidth
-
Deprecated.
- withListener(OptimizationListener) - Method in class io.github.bucket4j.distributed.proxy.optimization.batch.BatchingOptimization
- withListener(OptimizationListener) - Method in class io.github.bucket4j.distributed.proxy.optimization.delay.DelayOptimization
- withListener(OptimizationListener) - Method in class io.github.bucket4j.distributed.proxy.optimization.manual.ManuallySyncingOptimization
- withListener(OptimizationListener) - Method in interface io.github.bucket4j.distributed.proxy.optimization.Optimization
-
Specifies the listener for optimization events
- withListener(OptimizationListener) - Method in class io.github.bucket4j.distributed.proxy.optimization.predictive.PredictiveOptimization
- withListener(OptimizationListener) - Method in class io.github.bucket4j.distributed.proxy.optimization.skiponzero.SkipSyncOnZeroOptimization
- withMapper(Function<? super K1, ? extends K>) - Method in interface io.github.bucket4j.distributed.proxy.AsyncProxyManager
-
Returns a proxy object that wraps this AsyncProxyManager such that keys are first mapped using the specified mapping function before being sent to the remote store.
- withMapper(Function<? super K1, ? extends K>) - Method in interface io.github.bucket4j.distributed.proxy.ProxyManager
-
Returns a proxy object that wraps this ProxyManager such that keys are first mapped using the specified mapping function before being sent to the remote store.
- withMapper(Function<? super K1, ? extends K>) - Method in interface io.github.bucket4j.distributed.proxy.RemoteAsyncBucketBuilder
-
Returns a proxy object that wraps this RemoteAsyncBucketBuilder such that keys are first mapped using the specified mapping function before being sent to the remote store.
- withMapper(Function<? super K1, ? extends K>) - Method in interface io.github.bucket4j.distributed.proxy.RemoteBucketBuilder
-
Returns a proxy object that wraps this RemoteBucketBuilder such that keys are first mapped using the specified mapping function before being sent to the remote store.
- withMath(MathType) - Method in class io.github.bucket4j.local.LocalBucketBuilder
-
Warnings: this is not a part of Public API.
- withMillisecondPrecision() - Method in class io.github.bucket4j.local.LocalBucketBuilder
-
Specifies
TimeMeter.SYSTEM_MILLISECONDSas time meter for buckets that will be created by this builder. - withNanosecondPrecision() - Method in class io.github.bucket4j.local.LocalBucketBuilder
-
Specifies
TimeMeter.SYSTEM_NANOTIMEas time meter for buckets that will be created by this builder. - withOptimization(Optimization) - Method in interface io.github.bucket4j.distributed.proxy.RemoteAsyncBucketBuilder
-
Configures the optimization strategy that will be applied for buckets that are built by this builder.
- withOptimization(Optimization) - Method in interface io.github.bucket4j.distributed.proxy.RemoteBucketBuilder
-
Configures the optimization strategy that will be applied for buckets that are built by this builder.
- withPrimaryKeyMapper(PrimaryKeyMapper<T>) - Method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfigurationBuilder
- withRecoveryStrategy(RecoveryStrategy) - Method in interface io.github.bucket4j.distributed.proxy.RemoteAsyncBucketBuilder
-
Configures custom recovery strategy instead of
RecoveryStrategy.RECONSTRUCTthat is used by default. - withRecoveryStrategy(RecoveryStrategy) - Method in interface io.github.bucket4j.distributed.proxy.RemoteBucketBuilder
-
Configures custom recovery strategy instead of
RecoveryStrategy.RECONSTRUCTthat is used by default. - withRequestTimeout(Duration) - Method in class io.github.bucket4j.distributed.proxy.ClientSideConfig
-
Returns new instance of
ClientSideConfigwith configured timeout for remote operations. - withSynchronizationStrategy(SynchronizationStrategy) - Method in class io.github.bucket4j.local.LocalBucketBuilder
-
Specifies
synchronizationStrategyfor buckets that will be created by this builder. - withTableSettings(BucketTableSettings) - Method in class io.github.bucket4j.distributed.jdbc.SQLProxyConfigurationBuilder
- writeBoolean(DataOutput, boolean) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- writeBoolean(T, boolean) - Method in interface io.github.bucket4j.distributed.serialization.SerializationAdapter
- writeByte(DataOutput, byte) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- writeByte(T, byte) - Method in interface io.github.bucket4j.distributed.serialization.SerializationAdapter
- writeDoubleArray(DataOutput, double[]) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- writeDoubleArray(T, double[]) - Method in interface io.github.bucket4j.distributed.serialization.SerializationAdapter
- writeInt(DataOutput, int) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- writeInt(T, int) - Method in interface io.github.bucket4j.distributed.serialization.SerializationAdapter
- writeLong(DataOutput, long) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- writeLong(T, long) - Method in interface io.github.bucket4j.distributed.serialization.SerializationAdapter
- writeLongArray(DataOutput, long[]) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- writeLongArray(T, long[]) - Method in interface io.github.bucket4j.distributed.serialization.SerializationAdapter
- writeString(DataOutput, String) - Method in class io.github.bucket4j.distributed.serialization.DataOutputSerializationAdapter
- writeString(T, String) - Method in interface io.github.bucket4j.distributed.serialization.SerializationAdapter
- wrongValueOfMinSamplesForPredictionParameters(int) - Static method in class io.github.bucket4j.BucketExceptions
Z
- ZERO - Static variable in class io.github.bucket4j.distributed.remote.CommandResult
All Classes All Packages