io.github.bucket4j.grid

Class GridBucket

java.lang.Object

io.github.bucket4j.AbstractBucket

io.github.bucket4j.grid.GridBucket

All Implemented Interfaces:

Bucket

public class GridBucket
extends AbstractBucket

Field Summary

Fields inherited from class io.github.bucket4j.AbstractBucket

bandwidths, configuration, timeMeter, UNSPECIFIED_WAITING_LIMIT

Constructor Summary

Constructors

Constructor and Description
GridBucket(BucketConfiguration configuration, GridProxy gridProxy, RecoveryStrategy recoveryStrategy)

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)
BucketState	createSnapshot() Creates the copy of internal state.
protected boolean	tryConsumeImpl(long tokensToConsume)

Methods inherited from class io.github.bucket4j.AbstractBucket

addTokens, consume, consume, consumeUninterruptibly, consumeUninterruptibly, getConfiguration, tryConsume, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible

Methods inherited from class java.lang.Object

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

Constructor Detail

GridBucket

public GridBucket(BucketConfiguration configuration,
                  GridProxy gridProxy,
                  RecoveryStrategy recoveryStrategy)

Method Detail

consumeAsMuchAsPossibleImpl

protected long consumeAsMuchAsPossibleImpl(long limit)

Specified by:

consumeAsMuchAsPossibleImpl in class AbstractBucket

tryConsumeImpl

protected boolean tryConsumeImpl(long tokensToConsume)

Specified by:

tryConsumeImpl in class AbstractBucket

consumeOrAwaitImpl

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

Specified by:

consumeOrAwaitImpl in class AbstractBucket

Throws:

InterruptedException

addTokensImpl

protected void addTokensImpl(long tokensToAdd)

Specified by:

addTokensImpl 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.

Returns:

snapshot of internal state