public class LockFreeBucket extends AbstractBucket implements LocalBucket
Constructor and Description |
---|
LockFreeBucket(BucketConfiguration configuration,
TimeMeter timeMeter) |
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) |
Bucket |
toListenable(BucketListener listener)
Returns new copy of this bucket instance decorated by
listener . |
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) |
addTokens, asAsync, asAsyncScheduler, asScheduler, consume, consumeUninterruptibly, replaceConfiguration, tryConsume, tryConsume, tryConsumeAndReturnRemaining, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible, tryConsumeUninterruptibly
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addTokens, asAsync, asAsyncScheduler, asScheduler, replaceConfiguration, tryConsume, tryConsumeAndReturnRemaining, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible
consume, consumeUninterruptibly, tryConsume, tryConsume, tryConsume, tryConsumeUninterruptibly, tryConsumeUninterruptibly, tryConsumeUninterruptibly
public LockFreeBucket(BucketConfiguration configuration, TimeMeter timeMeter)
public Bucket toListenable(BucketListener listener)
Bucket
listener
.
See javadocs for BucketListener
in order to understand semantic of listener.toListenable
in interface Bucket
listener
- the listener of bucket events.listener
public boolean isAsyncModeSupported()
Bucket
If asynchronous mode is not supported any attempt to call Bucket.asAsync()
will fail with UnsupportedOperationException
isAsyncModeSupported
in interface Bucket
protected long consumeAsMuchAsPossibleImpl(long limit)
consumeAsMuchAsPossibleImpl
in class AbstractBucket
protected boolean tryConsumeImpl(long tokensToConsume)
tryConsumeImpl
in class AbstractBucket
protected ConsumptionProbe tryConsumeAndReturnRemainingTokensImpl(long tokensToConsume)
tryConsumeAndReturnRemainingTokensImpl
in class AbstractBucket
protected long reserveAndCalculateTimeToSleepImpl(long tokensToConsume, long waitIfBusyNanosLimit)
reserveAndCalculateTimeToSleepImpl
in class AbstractBucket
protected void addTokensImpl(long tokensToAdd)
addTokensImpl
in class AbstractBucket
protected void replaceConfigurationImpl(BucketConfiguration newConfiguration)
replaceConfigurationImpl
in class AbstractBucket
public long getAvailableTokens()
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.
getAvailableTokens
in interface Bucket
protected CompletableFuture<Boolean> tryConsumeAsyncImpl(long tokensToConsume)
tryConsumeAsyncImpl
in class AbstractBucket
protected CompletableFuture<Void> addTokensAsyncImpl(long tokensToAdd)
addTokensAsyncImpl
in class AbstractBucket
protected CompletableFuture<Void> replaceConfigurationAsyncImpl(BucketConfiguration newConfiguration)
replaceConfigurationAsyncImpl
in class AbstractBucket
protected CompletableFuture<ConsumptionProbe> tryConsumeAndReturnRemainingTokensAsyncImpl(long tokensToConsume)
tryConsumeAndReturnRemainingTokensAsyncImpl
in class AbstractBucket
protected CompletableFuture<Long> tryConsumeAsMuchAsPossibleAsyncImpl(long limit)
tryConsumeAsMuchAsPossibleAsyncImpl
in class AbstractBucket
protected CompletableFuture<Long> reserveAndCalculateTimeToSleepAsyncImpl(long tokensToConsume, long maxWaitTimeNanos)
reserveAndCalculateTimeToSleepAsyncImpl
in class AbstractBucket
public BucketState createSnapshot()
Bucket
This method is designed to be used only for monitoring and testing, you should never use this method for business cases.
createSnapshot
in interface Bucket
public BucketConfiguration getConfiguration()
LocalBucket
getConfiguration
in interface LocalBucket
Copyright © 2018. All rights reserved.