Module io.github.bucket4j.core

Package io.github.bucket4j.local

Class LockFreeBucket

java.lang.Object

io.github.bucket4j.AbstractBucket

io.github.bucket4j.local.LockFreeBucket

All Implemented Interfaces:

BlockingBucket, Bucket, LocalBucket, SchedulingBucket, ComparableByContent<LockFreeBucket>

public class LockFreeBucket
extends AbstractBucket
implements LocalBucket, ComparableByContent<LockFreeBucket>

Field Summary

Fields

Modifier and Type	Field	Description
static SerializationHandle<LockFreeBucket>	SERIALIZATION_HANDLE

Fields inherited from class io.github.bucket4j.AbstractBucket

INFINITY_DURATION, UNLIMITED_AMOUNT

Constructor Summary

Constructors

Constructor	Description
LockFreeBucket(BucketConfiguration configuration, MathType mathType, TimeMeter timeMeter)

Method Summary

Modifier and Type	Method	Description
protected void	addTokensImpl(long tokensToAdd)
protected VerboseResult<Nothing>	addTokensVerboseImpl(long tokensToAdd)
protected long	consumeAsMuchAsPossibleImpl(long limit)
protected VerboseResult<Long>	consumeAsMuchAsPossibleVerboseImpl(long limit)
protected long	consumeIgnoringRateLimitsImpl(long tokensToConsume)
protected VerboseResult<Long>	consumeIgnoringRateLimitsVerboseImpl(long tokensToConsume)
boolean	equalsByContent(LockFreeBucket other)
protected EstimationProbe	estimateAbilityToConsumeImpl(long tokensToEstimate)
protected VerboseResult<EstimationProbe>	estimateAbilityToConsumeVerboseImpl(long tokensToEstimate)
protected void	forceAddTokensImpl(long tokensToAdd)
protected VerboseResult<Nothing>	forceAddTokensVerboseImpl(long tokensToAdd)
long	getAvailableTokens()	Returns amount of available tokens in this bucket.
protected VerboseResult<Long>	getAvailableTokensVerboseImpl()
BucketConfiguration	getConfiguration()	Returns configuration of this bucket.
SynchronizationStrategy	getSynchronizationStrategy()	Returns the synchronization strategy that is used by this bucket
TimeMeter	getTimeMeter()	Returns the clock that is used by this bucket
protected void	replaceConfigurationImpl(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)
protected VerboseResult<Nothing>	replaceConfigurationVerboseImpl(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)
protected long	reserveAndCalculateTimeToSleepImpl(long tokensToConsume, long waitIfBusyNanosLimit)
void	reset()	Reset all tokens up to maximum capacity.
protected VerboseResult<Nothing>	resetVerboseImpl()
Bucket	toListenable(BucketListener listener)	Returns new copy of this bucket instance decorated by listener.
String	toString()
protected ConsumptionProbe	tryConsumeAndReturnRemainingTokensImpl(long tokensToConsume)
protected VerboseResult<ConsumptionProbe>	tryConsumeAndReturnRemainingTokensVerboseImpl(long tokensToConsume)
protected boolean	tryConsumeImpl(long tokensToConsume)
protected VerboseResult<Boolean>	tryConsumeVerboseImpl(long tokensToConsume)

Methods inherited from class io.github.bucket4j.AbstractBucket

addTokens, asBlocking, asScheduler, asVerbose, completedFuture, consume, consume, consumeIgnoringRateLimits, consumeUninterruptibly, estimateAbilityToConsume, failedFuture, forceAddTokens, getListener, replaceConfiguration, tryConsume, tryConsume, tryConsume, tryConsumeAndReturnRemaining, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible, tryConsumeUninterruptibly

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.bucket4j.BlockingBucket

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

Methods inherited from interface io.github.bucket4j.Bucket

addTokens, asBlocking, asScheduler, asVerbose, consumeIgnoringRateLimits, estimateAbilityToConsume, forceAddTokens, replaceConfiguration, tryConsume, tryConsumeAndReturnRemaining, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible

Methods inherited from interface io.github.bucket4j.local.LocalBucket

toBinarySnapshot, toJsonCompatibleSnapshot

Methods inherited from interface io.github.bucket4j.SchedulingBucket

tryConsume

Field Detail

SERIALIZATION_HANDLE

public static final SerializationHandle<LockFreeBucket> SERIALIZATION_HANDLE

Constructor Detail

LockFreeBucket

public LockFreeBucket(BucketConfiguration configuration,
                      MathType mathType,
                      TimeMeter timeMeter)

Method Detail

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.

Specified by:

toListenable in interface Bucket

Parameters:

listener - the listener of bucket events.

Returns:

new bucket instance decorated by listener

consumeAsMuchAsPossibleImpl

protected long consumeAsMuchAsPossibleImpl(long limit)

Specified by:

consumeAsMuchAsPossibleImpl in class AbstractBucket

tryConsumeImpl

protected boolean tryConsumeImpl(long tokensToConsume)

Specified by:

tryConsumeImpl in class AbstractBucket

tryConsumeAndReturnRemainingTokensImpl

protected ConsumptionProbe tryConsumeAndReturnRemainingTokensImpl(long tokensToConsume)

Specified by:

tryConsumeAndReturnRemainingTokensImpl in class AbstractBucket

estimateAbilityToConsumeImpl

protected EstimationProbe estimateAbilityToConsumeImpl(long tokensToEstimate)

Specified by:

estimateAbilityToConsumeImpl in class AbstractBucket

reserveAndCalculateTimeToSleepImpl

protected long reserveAndCalculateTimeToSleepImpl(long tokensToConsume,
                                                  long waitIfBusyNanosLimit)

Specified by:

reserveAndCalculateTimeToSleepImpl 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

reset

public void reset()

Description copied from interface: Bucket

Reset all tokens up to maximum capacity.

Specified by:

reset in interface Bucket

replaceConfigurationImpl

protected void replaceConfigurationImpl(BucketConfiguration newConfiguration,
                                        TokensInheritanceStrategy tokensInheritanceStrategy)

Specified by:

replaceConfigurationImpl 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 tokensToEstimate)

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

resetVerboseImpl

protected VerboseResult<Nothing> resetVerboseImpl()

Specified by:

resetVerboseImpl 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

getAvailableTokens

public long getAvailableTokens()

Description copied from interface: Bucket

Returns amount of available tokens in this bucket.

Typically you should avoid using of this method for, because available tokens can be changed by concurrent transactions for case of multithreaded/multi-process environment.

Specified by:

getAvailableTokens in interface Bucket

Returns:

amount of available tokens

getConfiguration

public BucketConfiguration getConfiguration()

Description copied from interface: LocalBucket

Returns configuration of this bucket.

Specified by:

getConfiguration in interface LocalBucket

Returns:

configuration

getTimeMeter

public TimeMeter getTimeMeter()

Description copied from interface: LocalBucket

Returns the clock that is used by this bucket

Specified by:

getTimeMeter in interface LocalBucket

Returns:

the clock that is used by this bucket

getSynchronizationStrategy

public SynchronizationStrategy getSynchronizationStrategy()

Description copied from interface: LocalBucket

Returns the synchronization strategy that is used by this bucket

Specified by:

getSynchronizationStrategy in interface LocalBucket

Returns:

synchronization strategy that is used by this bucket

toString

public String toString()

Overrides:

toString in class Object

equalsByContent

public boolean equalsByContent(LockFreeBucket other)

Specified by:

equalsByContent in interface ComparableByContent<LockFreeBucket>