io.github.bucket4j.local

Class SynchronizedBucket

java.lang.Object

io.github.bucket4j.AbstractBucket

io.github.bucket4j.local.SynchronizedBucket

All Implemented Interfaces:

Bucket, LocalBucket

public class SynchronizedBucket
extends AbstractBucket
implements LocalBucket

Constructor Summary

Constructors

Constructor and Description
SynchronizedBucket(BucketConfiguration configuration, TimeMeter timeMeter)
SynchronizedBucket(BucketConfiguration configuration, TimeMeter timeMeter, Lock lock)

Method Summary

Modifier and Type	Method and Description
protected CompletableFuture<Void>	addTokensAsyncImpl(long tokensToAdd)
protected void	addTokensImpl(long tokensToAdd)
protected long	consumeAsMuchAsPossibleImpl(long limit)
BucketState	createSnapshot() Creates the copy of internal state.
long	getAvailableTokens() Returns amount of available tokens in this bucket.
BucketConfiguration	getConfiguration() Returns configuration of this bucket.
boolean	isAsyncModeSupported() Describes whether or not this bucket supports asynchronous mode.
protected CompletableFuture<Void>	replaceConfigurationAsyncImpl(BucketConfiguration newConfiguration)
protected void	replaceConfigurationImpl(BucketConfiguration newConfiguration)
protected CompletableFuture<Long>	reserveAndCalculateTimeToSleepAsyncImpl(long tokensToConsume, long maxWaitTimeNanos)
protected long	reserveAndCalculateTimeToSleepImpl(long tokensToConsume, long waitIfBusyNanosLimit)
String	toString()
protected CompletableFuture<ConsumptionProbe>	tryConsumeAndReturnRemainingTokensAsyncImpl(long tokensToConsume)
protected ConsumptionProbe	tryConsumeAndReturnRemainingTokensImpl(long tokensToConsume)
protected CompletableFuture<Long>	tryConsumeAsMuchAsPossibleAsyncImpl(long limit)
protected CompletableFuture<Boolean>	tryConsumeAsyncImpl(long tokensToConsume)
protected boolean	tryConsumeImpl(long tokensToConsume)

Methods inherited from class io.github.bucket4j.AbstractBucket

addTokens, asAsync, replaceConfiguration, 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.Bucket

addTokens, asAsync, replaceConfiguration, tryConsume, tryConsume, tryConsumeAndReturnRemaining, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible, tryConsumeUninterruptibly

Constructor Detail

SynchronizedBucket

public SynchronizedBucket(BucketConfiguration configuration,
                          TimeMeter timeMeter)

SynchronizedBucket

public SynchronizedBucket(BucketConfiguration configuration,
                          TimeMeter timeMeter,
                          Lock lock)

Method Detail

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

Specified by:

isAsyncModeSupported in interface Bucket

Returns:

true if this extension supports asynchronous mode.

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

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

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.

Specified by:

getAvailableTokens in interface Bucket

Returns:

amount of available tokens

replaceConfigurationImpl

protected void replaceConfigurationImpl(BucketConfiguration newConfiguration)

Specified by:

replaceConfigurationImpl in class AbstractBucket

tryConsumeAsyncImpl

protected CompletableFuture<Boolean> tryConsumeAsyncImpl(long tokensToConsume)

Specified by:

tryConsumeAsyncImpl in class AbstractBucket

Returns:

addTokensAsyncImpl

protected CompletableFuture<Void> addTokensAsyncImpl(long tokensToAdd)

Specified by:

addTokensAsyncImpl in class AbstractBucket

Returns:

tryConsumeAndReturnRemainingTokensAsyncImpl

protected CompletableFuture<ConsumptionProbe> tryConsumeAndReturnRemainingTokensAsyncImpl(long tokensToConsume)

Specified by:

tryConsumeAndReturnRemainingTokensAsyncImpl in class AbstractBucket

Returns:

tryConsumeAsMuchAsPossibleAsyncImpl

protected CompletableFuture<Long> tryConsumeAsMuchAsPossibleAsyncImpl(long limit)

Specified by:

tryConsumeAsMuchAsPossibleAsyncImpl in class AbstractBucket

Returns:

reserveAndCalculateTimeToSleepAsyncImpl

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

Specified by:

reserveAndCalculateTimeToSleepAsyncImpl in class AbstractBucket

Returns:

replaceConfigurationAsyncImpl

protected CompletableFuture<Void> replaceConfigurationAsyncImpl(BucketConfiguration newConfiguration)

Specified by:

replaceConfigurationAsyncImpl in class AbstractBucket

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.

Specified by:

createSnapshot in interface Bucket

Returns:

snapshot of internal state

getConfiguration

public BucketConfiguration getConfiguration()

Description copied from interface: LocalBucket

Returns configuration of this bucket.

Specified by:

getConfiguration in interface LocalBucket

Returns:

configuration

toString

public String toString()

Overrides:

toString in class Object