Module io.github.bucket4j.core

Package io.github.bucket4j.distributed.remote.commands

Class ConsumeAsMuchAsPossibleCommand

java.lang.Object

io.github.bucket4j.distributed.remote.commands.ConsumeAsMuchAsPossibleCommand

All Implemented Interfaces:

RemoteCommand<Long>, ComparableByContent<ConsumeAsMuchAsPossibleCommand>

public class ConsumeAsMuchAsPossibleCommand
extends Object
implements RemoteCommand<Long>, ComparableByContent<ConsumeAsMuchAsPossibleCommand>

Field Summary

Fields

Modifier and Type	Field	Description
static SerializationHandle<ConsumeAsMuchAsPossibleCommand>	SERIALIZATION_HANDLE

Constructor Summary

Constructors

Constructor	Description
ConsumeAsMuchAsPossibleCommand(long limit)

Method Summary

Modifier and Type	Method	Description
boolean	equalsByContent(ConsumeAsMuchAsPossibleCommand other)
long	estimateTokensToConsume()
CommandResult<Long>	execute(MutableBucketEntry mutableEntry, long currentTimeNanos)
long	getConsumedTokens(Long result)
long	getLimit()
int	getMergedCommandsCount()
Version	getRequiredVersion()
SerializationHandle	getSerializationHandle()
boolean	isImmediateSyncRequired(long unsynchronizedTokens, long nanosSinceLastSync)
boolean	isMerged()
void	setLimit(long limit)
void	setMerged(boolean merged)
CommandResult<?>	unwrapOneResult(Long consumedTokens, int indice)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.bucket4j.distributed.remote.RemoteCommand

asVerbose, canBeMerged, isInitializationCommand, mergeInto, toMergedCommand

Field Detail

SERIALIZATION_HANDLE

public static final SerializationHandle<ConsumeAsMuchAsPossibleCommand> SERIALIZATION_HANDLE

Constructor Detail

ConsumeAsMuchAsPossibleCommand

public ConsumeAsMuchAsPossibleCommand(long limit)

Method Detail

execute

public CommandResult<Long> execute(MutableBucketEntry mutableEntry,
                                   long currentTimeNanos)

Specified by:

execute in interface RemoteCommand<Long>

getLimit

public long getLimit()

setLimit

public void setLimit(long limit)

getSerializationHandle

public SerializationHandle getSerializationHandle()

Specified by:

getSerializationHandle in interface RemoteCommand<Long>

equalsByContent

public boolean equalsByContent(ConsumeAsMuchAsPossibleCommand other)

Specified by:

equalsByContent in interface ComparableByContent<ConsumeAsMuchAsPossibleCommand>

isImmediateSyncRequired

public boolean isImmediateSyncRequired(long unsynchronizedTokens,
                                       long nanosSinceLastSync)

Specified by:

isImmediateSyncRequired in interface RemoteCommand<Long>

estimateTokensToConsume

public long estimateTokensToConsume()

Specified by:

estimateTokensToConsume in interface RemoteCommand<Long>

getConsumedTokens

public long getConsumedTokens(Long result)

Specified by:

getConsumedTokens in interface RemoteCommand<Long>

getRequiredVersion

public Version getRequiredVersion()

Specified by:

getRequiredVersion in interface RemoteCommand<Long>

isMerged

public boolean isMerged()

Specified by:

isMerged in interface RemoteCommand<Long>

getMergedCommandsCount

public int getMergedCommandsCount()

Specified by:

getMergedCommandsCount in interface RemoteCommand<Long>

unwrapOneResult

public CommandResult<?> unwrapOneResult(Long consumedTokens,
                                        int indice)

Specified by:

unwrapOneResult in interface RemoteCommand<Long>

setMerged

public void setMerged(boolean merged)