Module io.github.bucket4j.core

Package io.github.bucket4j.distributed

Interface AsyncVerboseBucket

public interface AsyncVerboseBucket

Intent of this interface is to provide the verbose version of AsyncBucketProxy API. All methods obey the same semantic but its results are more verbose.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<VerboseResult<Nothing>>	addTokens(long tokensToAdd)	Does the same that Bucket.addTokens(long)
CompletableFuture<VerboseResult<Long>>	consumeIgnoringRateLimits(long tokens)	Does the same that Bucket.consumeIgnoringRateLimits(long)
CompletableFuture<VerboseResult<EstimationProbe>>	estimateAbilityToConsume(long numTokens)	Does the same that Bucket.estimateAbilityToConsume(long)
CompletableFuture<VerboseResult<Nothing>>	forceAddTokens(long tokensToAdd)	Does the same that Bucket.addTokens(long)
CompletableFuture<VerboseResult<Long>>	getAvailableTokens()	Does the same that Bucket.getAvailableTokens()
CompletableFuture<VerboseResult<Nothing>>	replaceConfiguration(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)	Does the same that Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)
CompletableFuture<VerboseResult<Nothing>>	reset()	Does the same that Bucket.reset()
CompletableFuture<VerboseResult<Boolean>>	tryConsume(long numTokens)	Does the same that Bucket.tryConsume(long)
CompletableFuture<VerboseResult<ConsumptionProbe>>	tryConsumeAndReturnRemaining(long numTokens)	Does the same that Bucket.tryConsumeAndReturnRemaining(long)
CompletableFuture<VerboseResult<Long>>	tryConsumeAsMuchAsPossible()	Does the same that Bucket.tryConsumeAsMuchAsPossible()
CompletableFuture<VerboseResult<Long>>	tryConsumeAsMuchAsPossible(long limit)	Does the same that Bucket.tryConsumeAsMuchAsPossible(long)

Method Detail

tryConsume

CompletableFuture<VerboseResult<Boolean>> tryConsume(long numTokens)

Does the same that Bucket.tryConsume(long)

consumeIgnoringRateLimits

CompletableFuture<VerboseResult<Long>> consumeIgnoringRateLimits(long tokens)

Does the same that Bucket.consumeIgnoringRateLimits(long)

tryConsumeAndReturnRemaining

CompletableFuture<VerboseResult<ConsumptionProbe>> tryConsumeAndReturnRemaining(long numTokens)

Does the same that Bucket.tryConsumeAndReturnRemaining(long)

estimateAbilityToConsume

CompletableFuture<VerboseResult<EstimationProbe>> estimateAbilityToConsume(long numTokens)

Does the same that Bucket.estimateAbilityToConsume(long)

tryConsumeAsMuchAsPossible

CompletableFuture<VerboseResult<Long>> tryConsumeAsMuchAsPossible()

Does the same that Bucket.tryConsumeAsMuchAsPossible()

tryConsumeAsMuchAsPossible

CompletableFuture<VerboseResult<Long>> tryConsumeAsMuchAsPossible(long limit)

Does the same that Bucket.tryConsumeAsMuchAsPossible(long)

addTokens

CompletableFuture<VerboseResult<Nothing>> addTokens(long tokensToAdd)

Does the same that Bucket.addTokens(long)

forceAddTokens

CompletableFuture<VerboseResult<Nothing>> forceAddTokens(long tokensToAdd)

Does the same that Bucket.addTokens(long)

reset

CompletableFuture<VerboseResult<Nothing>> reset()

Does the same that Bucket.reset()

replaceConfiguration

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

Does the same that Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)

getAvailableTokens

CompletableFuture<VerboseResult<Long>> getAvailableTokens()

Does the same that Bucket.getAvailableTokens()