io.github.bucket4j.grid

Class GridBucket<K extends Serializable>

java.lang.Object

io.github.bucket4j.AbstractBucket

io.github.bucket4j.grid.GridBucket<K>

Type Parameters:

K - type of key

All Implemented Interfaces:

BlockingBucket, Bucket

public class GridBucket<K extends Serializable>
extends AbstractBucket

Represents the bucket which state actually stored outside current JVM.

Field Summary

Fields inherited from class io.github.bucket4j.AbstractBucket

INFINITY_DURATION

Method Summary

Modifier and Type	Method and Description
protected CompletableFuture<Void>	addTokensAsyncImpl(long tokensToAdd)
protected void	addTokensImpl(long tokensToAdd)
protected CompletableFuture<VerboseResult<Nothing>>	addTokensVerboseAsyncImpl(long tokensToAdd)
protected VerboseResult<Nothing>	addTokensVerboseImpl(long tokensToAdd)
protected long	consumeAsMuchAsPossibleImpl(long limit)
protected VerboseResult<Long>	consumeAsMuchAsPossibleVerboseImpl(long limit)
protected CompletableFuture<Long>	consumeIgnoringRateLimitsAsyncImpl(long tokensToConsume)
protected long	consumeIgnoringRateLimitsImpl(long tokensToConsume)
protected CompletableFuture<VerboseResult<Long>>	consumeIgnoringRateLimitsVerboseAsyncImpl(long tokensToConsume)
protected VerboseResult<Long>	consumeIgnoringRateLimitsVerboseImpl(long tokensToConsume)
static <T extends Serializable> GridBucket<T>	createInitializedBucket(T key, BucketConfiguration configuration, GridProxy<T> gridProxy, RecoveryStrategy recoveryStrategy)
static <T extends Serializable> GridBucket<T>	createLazyBucket(T key, Supplier<BucketConfiguration> configurationSupplier, GridProxy<T> gridProxy)
BucketState	createSnapshot() Creates the copy of internal state.
protected CompletableFuture<EstimationProbe>	estimateAbilityToConsumeAsyncImpl(long tokensToEstimate)
protected EstimationProbe	estimateAbilityToConsumeImpl(long numTokens)
protected CompletableFuture<VerboseResult<EstimationProbe>>	estimateAbilityToConsumeVerboseAsyncImpl(long tokensToEstimate)
protected VerboseResult<EstimationProbe>	estimateAbilityToConsumeVerboseImpl(long numTokens)
protected CompletableFuture<Void>	forceAddTokensAsyncImpl(long tokensToAdd)
protected void	forceAddTokensImpl(long tokensToAdd)
protected CompletableFuture<VerboseResult<Nothing>>	forceAddTokensVerboseAsyncImpl(long tokensToAdd)
protected VerboseResult<Nothing>	forceAddTokensVerboseImpl(long tokensToAdd)
long	getAvailableTokens() Returns amount of available tokens in this bucket.
protected VerboseResult<Long>	getAvailableTokensVerboseImpl()
boolean	isAsyncModeSupported() Describes whether or not this bucket supports asynchronous mode.
protected CompletableFuture<Nothing>	replaceConfigurationAsyncImpl(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)
protected void	replaceConfigurationImpl(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)
protected CompletableFuture<VerboseResult<Nothing>>	replaceConfigurationVerboseAsyncImpl(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)
protected VerboseResult<Nothing>	replaceConfigurationVerboseImpl(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)
protected CompletableFuture<Long>	reserveAndCalculateTimeToSleepAsyncImpl(long tokensToConsume, long maxWaitTimeNanos)
protected long	reserveAndCalculateTimeToSleepImpl(long tokensToConsume, long waitIfBusyNanosLimit)
Bucket	toListenable(BucketListener listener) Returns new copy of this bucket instance decorated by listener.
protected CompletableFuture<ConsumptionProbe>	tryConsumeAndReturnRemainingTokensAsyncImpl(long tokensToConsume)
protected ConsumptionProbe	tryConsumeAndReturnRemainingTokensImpl(long tokensToConsume)
protected CompletableFuture<VerboseResult<ConsumptionProbe>>	tryConsumeAndReturnRemainingTokensVerboseAsyncImpl(long tokensToConsume)
protected VerboseResult<ConsumptionProbe>	tryConsumeAndReturnRemainingTokensVerboseImpl(long tokensToConsume)
protected CompletableFuture<Long>	tryConsumeAsMuchAsPossibleAsyncImpl(long limit)
protected CompletableFuture<VerboseResult<Long>>	tryConsumeAsMuchAsPossibleVerboseAsyncImpl(long limit)
protected CompletableFuture<Boolean>	tryConsumeAsyncImpl(long tokensToConsume)
protected boolean	tryConsumeImpl(long tokensToConsume)
protected CompletableFuture<VerboseResult<Boolean>>	tryConsumeVerboseAsyncImpl(long tokensToConsume)
protected VerboseResult<Boolean>	tryConsumeVerboseImpl(long tokensToConsume)

Methods inherited from class io.github.bucket4j.AbstractBucket

addTokens, asAsync, asAsyncScheduler, asScheduler, asVerbose, consume, consumeIgnoringRateLimits, consumeUninterruptibly, estimateAbilityToConsume, forceAddTokens, replaceConfiguration, tryConsume, tryConsume, tryConsumeAndReturnRemaining, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible, tryConsumeUninterruptibly

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.bucket4j.BlockingBucket

consume, consumeUninterruptibly, tryConsume, tryConsume, tryConsume, tryConsumeUninterruptibly, tryConsumeUninterruptibly, tryConsumeUninterruptibly

Method Detail

createLazyBucket

public static <T extends Serializable> GridBucket<T> createLazyBucket(T key,
                                                                      Supplier<BucketConfiguration> configurationSupplier,
                                                                      GridProxy<T> gridProxy)

createInitializedBucket

public static <T extends Serializable> GridBucket<T> createInitializedBucket(T key,
                                                                             BucketConfiguration configuration,
                                                                             GridProxy<T> gridProxy,
                                                                             RecoveryStrategy recoveryStrategy)

toListenable

public Bucket toListenable(BucketListener listener)

Description copied from interface: Bucket

Returns new copy of this bucket instance decorated by listener. The created bucket will share same tokens with source bucket and vice versa. See javadocs for BucketListener in order to understand semantic of listener.

Parameters:

listener - the listener of bucket events.

Returns:

new bucket instance decorated by listener

isAsyncModeSupported

public boolean isAsyncModeSupported()

Description copied from interface: Bucket

Describes whether or not this bucket supports asynchronous mode.

If asynchronous mode is not supported any attempt to call Bucket.asAsync() will fail with UnsupportedOperationException

Returns:

true if this extension supports asynchronous mode.

consumeAsMuchAsPossibleImpl

protected long consumeAsMuchAsPossibleImpl(long limit)

Specified by:

consumeAsMuchAsPossibleImpl in class AbstractBucket

tryConsumeAsMuchAsPossibleAsyncImpl

protected CompletableFuture<Long> tryConsumeAsMuchAsPossibleAsyncImpl(long limit)

Specified by:

tryConsumeAsMuchAsPossibleAsyncImpl in class AbstractBucket

tryConsumeImpl

protected boolean tryConsumeImpl(long tokensToConsume)

Specified by:

tryConsumeImpl in class AbstractBucket

tryConsumeAsyncImpl

protected CompletableFuture<Boolean> tryConsumeAsyncImpl(long tokensToConsume)

Specified by:

tryConsumeAsyncImpl in class AbstractBucket

tryConsumeAndReturnRemainingTokensImpl

protected ConsumptionProbe tryConsumeAndReturnRemainingTokensImpl(long tokensToConsume)

Specified by:

tryConsumeAndReturnRemainingTokensImpl in class AbstractBucket

estimateAbilityToConsumeImpl

protected EstimationProbe estimateAbilityToConsumeImpl(long numTokens)

Specified by:

estimateAbilityToConsumeImpl in class AbstractBucket

tryConsumeAndReturnRemainingTokensAsyncImpl

protected CompletableFuture<ConsumptionProbe> tryConsumeAndReturnRemainingTokensAsyncImpl(long tokensToConsume)

Specified by:

tryConsumeAndReturnRemainingTokensAsyncImpl in class AbstractBucket

estimateAbilityToConsumeAsyncImpl

protected CompletableFuture<EstimationProbe> estimateAbilityToConsumeAsyncImpl(long tokensToEstimate)

Specified by:

estimateAbilityToConsumeAsyncImpl in class AbstractBucket

reserveAndCalculateTimeToSleepImpl

protected long reserveAndCalculateTimeToSleepImpl(long tokensToConsume,
                                                  long waitIfBusyNanosLimit)

Specified by:

reserveAndCalculateTimeToSleepImpl in class AbstractBucket

consumeIgnoringRateLimitsImpl

protected long consumeIgnoringRateLimitsImpl(long tokensToConsume)

Specified by:

consumeIgnoringRateLimitsImpl in class AbstractBucket

consumeAsMuchAsPossibleVerboseImpl

protected VerboseResult<Long> consumeAsMuchAsPossibleVerboseImpl(long limit)

Specified by:

consumeAsMuchAsPossibleVerboseImpl in class AbstractBucket

tryConsumeVerboseImpl

protected VerboseResult<Boolean> tryConsumeVerboseImpl(long tokensToConsume)

Specified by:

tryConsumeVerboseImpl in class AbstractBucket

tryConsumeAndReturnRemainingTokensVerboseImpl

protected VerboseResult<ConsumptionProbe> tryConsumeAndReturnRemainingTokensVerboseImpl(long tokensToConsume)

Specified by:

tryConsumeAndReturnRemainingTokensVerboseImpl in class AbstractBucket

estimateAbilityToConsumeVerboseImpl

protected VerboseResult<EstimationProbe> estimateAbilityToConsumeVerboseImpl(long numTokens)

Specified by:

estimateAbilityToConsumeVerboseImpl in class AbstractBucket

getAvailableTokensVerboseImpl

protected VerboseResult<Long> getAvailableTokensVerboseImpl()

Specified by:

getAvailableTokensVerboseImpl in class AbstractBucket

addTokensVerboseImpl

protected VerboseResult<Nothing> addTokensVerboseImpl(long tokensToAdd)

Specified by:

addTokensVerboseImpl in class AbstractBucket

forceAddTokensVerboseImpl

protected VerboseResult<Nothing> forceAddTokensVerboseImpl(long tokensToAdd)

Specified by:

forceAddTokensVerboseImpl in class AbstractBucket

replaceConfigurationVerboseImpl

protected VerboseResult<Nothing> replaceConfigurationVerboseImpl(BucketConfiguration newConfiguration,
                                                                 TokensInheritanceStrategy tokensInheritanceStrategy)

Specified by:

replaceConfigurationVerboseImpl in class AbstractBucket

consumeIgnoringRateLimitsVerboseImpl

protected VerboseResult<Long> consumeIgnoringRateLimitsVerboseImpl(long tokensToConsume)

Specified by:

consumeIgnoringRateLimitsVerboseImpl in class AbstractBucket

reserveAndCalculateTimeToSleepAsyncImpl

protected CompletableFuture<Long> reserveAndCalculateTimeToSleepAsyncImpl(long tokensToConsume,
                                                                          long maxWaitTimeNanos)

Specified by:

reserveAndCalculateTimeToSleepAsyncImpl in class AbstractBucket

addTokensImpl

protected void addTokensImpl(long tokensToAdd)

Specified by:

addTokensImpl in class AbstractBucket

forceAddTokensImpl

protected void forceAddTokensImpl(long tokensToAdd)

Specified by:

forceAddTokensImpl in class AbstractBucket

addTokensAsyncImpl

protected CompletableFuture<Void> addTokensAsyncImpl(long tokensToAdd)

Specified by:

addTokensAsyncImpl in class AbstractBucket

forceAddTokensAsyncImpl

protected CompletableFuture<Void> forceAddTokensAsyncImpl(long tokensToAdd)

Specified by:

forceAddTokensAsyncImpl in class AbstractBucket

replaceConfigurationImpl

protected void replaceConfigurationImpl(BucketConfiguration newConfiguration,
                                        TokensInheritanceStrategy tokensInheritanceStrategy)

Specified by:

replaceConfigurationImpl in class AbstractBucket

replaceConfigurationAsyncImpl

protected CompletableFuture<Nothing> replaceConfigurationAsyncImpl(BucketConfiguration newConfiguration,
                                                                   TokensInheritanceStrategy tokensInheritanceStrategy)

Specified by:

replaceConfigurationAsyncImpl in class AbstractBucket

consumeIgnoringRateLimitsAsyncImpl

protected CompletableFuture<Long> consumeIgnoringRateLimitsAsyncImpl(long tokensToConsume)

Specified by:

consumeIgnoringRateLimitsAsyncImpl in class AbstractBucket

tryConsumeAsMuchAsPossibleVerboseAsyncImpl

protected CompletableFuture<VerboseResult<Long>> tryConsumeAsMuchAsPossibleVerboseAsyncImpl(long limit)

Specified by:

tryConsumeAsMuchAsPossibleVerboseAsyncImpl in class AbstractBucket

tryConsumeVerboseAsyncImpl

protected CompletableFuture<VerboseResult<Boolean>> tryConsumeVerboseAsyncImpl(long tokensToConsume)

Specified by:

tryConsumeVerboseAsyncImpl in class AbstractBucket

tryConsumeAndReturnRemainingTokensVerboseAsyncImpl

protected CompletableFuture<VerboseResult<ConsumptionProbe>> tryConsumeAndReturnRemainingTokensVerboseAsyncImpl(long tokensToConsume)

Specified by:

tryConsumeAndReturnRemainingTokensVerboseAsyncImpl in class AbstractBucket

estimateAbilityToConsumeVerboseAsyncImpl

protected CompletableFuture<VerboseResult<EstimationProbe>> estimateAbilityToConsumeVerboseAsyncImpl(long tokensToEstimate)

Specified by:

estimateAbilityToConsumeVerboseAsyncImpl in class AbstractBucket

addTokensVerboseAsyncImpl

protected CompletableFuture<VerboseResult<Nothing>> addTokensVerboseAsyncImpl(long tokensToAdd)

Specified by:

addTokensVerboseAsyncImpl in class AbstractBucket

forceAddTokensVerboseAsyncImpl

protected CompletableFuture<VerboseResult<Nothing>> forceAddTokensVerboseAsyncImpl(long tokensToAdd)

Specified by:

forceAddTokensVerboseAsyncImpl in class AbstractBucket

replaceConfigurationVerboseAsyncImpl

protected CompletableFuture<VerboseResult<Nothing>> replaceConfigurationVerboseAsyncImpl(BucketConfiguration newConfiguration,
                                                                                         TokensInheritanceStrategy tokensInheritanceStrategy)

Specified by:

replaceConfigurationVerboseAsyncImpl in class AbstractBucket

consumeIgnoringRateLimitsVerboseAsyncImpl

protected CompletableFuture<VerboseResult<Long>> consumeIgnoringRateLimitsVerboseAsyncImpl(long tokensToConsume)

Specified by:

consumeIgnoringRateLimitsVerboseAsyncImpl in class AbstractBucket

getAvailableTokens

public long getAvailableTokens()

Description copied from interface: Bucket

Returns amount of available tokens in this bucket.

This method designed to be used only for monitoring and testing, you should never use this method for business cases, because available tokens can be changed by concurrent transactions for case of multithreaded/multi-process environment.

Returns:

amount of available tokens

createSnapshot

public BucketState createSnapshot()

Description copied from interface: Bucket

Creates the copy of internal state.

This method is designed to be used only for monitoring and testing, you should never use this method for business cases.

Returns:

snapshot of internal state