Module io.github.bucket4j.core

Package io.github.bucket4j.distributed.remote

Class RemoteBucketState

java.lang.Object

io.github.bucket4j.distributed.remote.RemoteBucketState

All Implemented Interfaces:

ComparableByContent<RemoteBucketState>

public class RemoteBucketState
extends Object
implements ComparableByContent<RemoteBucketState>

Field Summary

Fields

Modifier and Type	Field	Description
static SerializationHandle<RemoteBucketState>	SERIALIZATION_HANDLE

Constructor Summary

Constructors

Constructor	Description
RemoteBucketState(BucketState state, RemoteStat stat, Long configurationVersion)

Method Summary

Modifier and Type	Method	Description
void	addTokens(long tokensToAdd)
long	calculateDelayNanosAfterWillBePossibleToConsume(long tokensToConsume, long currentTimeNanos, boolean checkTokensToConsumeShouldBeLessThenCapacity)
long	calculateFullRefillingTime(long currentTimeNanos)
void	consume(long tokensToConsume)
RemoteBucketState	copy()
BucketState	copyBucketState()
boolean	equalsByContent(RemoteBucketState other)
void	forceAddTokens(long tokensToAdd)
long	getAvailableTokens()
BucketConfiguration	getConfiguration()
Long	getConfigurationVersion()
RemoteStat	getRemoteStat()
BucketState	getState()
void	refillAllBandwidth(long currentTimeNanos)
void	replaceConfiguration(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy, long currentTimeNanos)
void	reset()
void	setConfigurationVersion(Long configurationVersion)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZATION_HANDLE

public static final SerializationHandle<RemoteBucketState> SERIALIZATION_HANDLE

Constructor Detail

RemoteBucketState

public RemoteBucketState(BucketState state,
                         RemoteStat stat,
                         Long configurationVersion)

Method Detail

refillAllBandwidth

public void refillAllBandwidth(long currentTimeNanos)

getAvailableTokens

public long getAvailableTokens()

consume

public void consume(long tokensToConsume)

calculateFullRefillingTime

public long calculateFullRefillingTime(long currentTimeNanos)

calculateDelayNanosAfterWillBePossibleToConsume

public long calculateDelayNanosAfterWillBePossibleToConsume(long tokensToConsume,
                                                            long currentTimeNanos,
                                                            boolean checkTokensToConsumeShouldBeLessThenCapacity)

addTokens

public void addTokens(long tokensToAdd)

forceAddTokens

public void forceAddTokens(long tokensToAdd)

reset

public void reset()

copyBucketState

public BucketState copyBucketState()

replaceConfiguration

public void replaceConfiguration(BucketConfiguration newConfiguration,
                                 TokensInheritanceStrategy tokensInheritanceStrategy,
                                 long currentTimeNanos)

getConfiguration

public BucketConfiguration getConfiguration()

getRemoteStat

public RemoteStat getRemoteStat()

getState

public BucketState getState()

getConfigurationVersion

public Long getConfigurationVersion()

setConfigurationVersion

public void setConfigurationVersion(Long configurationVersion)

equalsByContent

public boolean equalsByContent(RemoteBucketState other)

Specified by:

equalsByContent in interface ComparableByContent<RemoteBucketState>

copy

public RemoteBucketState copy()

toString

public String toString()

Overrides:

toString in class Object