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 -

All Implemented Interfaces:

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

UNSPECIFIED_WAITING_LIMIT

Method Summary

Modifier and Type	Method and Description
protected void	addTokensImpl(long tokensToAdd)
protected long	consumeAsMuchAsPossibleImpl(long limit)
protected boolean	consumeOrAwaitImpl(long tokensToConsume, long waitIfBusyNanosLimit, boolean uninterruptibly, BlockingStrategy blockingStrategy)
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.
long	getAvailableTokens() Returns amount of available tokens in this bucket.
BucketConfiguration	getConfiguration() Returns configuration of this bucket.
protected ConsumptionProbe	tryConsumeAndReturnRemainingTokensImpl(long tokensToConsume)
protected boolean	tryConsumeImpl(long tokensToConsume)

Methods inherited from class io.github.bucket4j.AbstractBucket

addTokens, consume, consume, consumeUninterruptibly, consumeUninterruptibly, tryConsume, tryConsumeAndReturnRemaining, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible

Methods inherited from class java.lang.Object

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

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)

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

consumeOrAwaitImpl

protected boolean consumeOrAwaitImpl(long tokensToConsume,
                                     long waitIfBusyNanosLimit,
                                     boolean uninterruptibly,
                                     BlockingStrategy blockingStrategy)
                              throws InterruptedException

Specified by:

consumeOrAwaitImpl in class AbstractBucket

Throws:

InterruptedException

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.

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

getConfiguration

public BucketConfiguration getConfiguration()

Description copied from interface: Bucket

Returns configuration of this bucket.

Returns:

configuration