Module io.github.bucket4j.core

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

Class TryConsumeAndReturnRemainingTokensCommand

java.lang.Object

io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand

All Implemented Interfaces:

RemoteCommand<ConsumptionProbe>, ComparableByContent<TryConsumeAndReturnRemainingTokensCommand>

public class TryConsumeAndReturnRemainingTokensCommand
extends Object
implements RemoteCommand<ConsumptionProbe>, ComparableByContent<TryConsumeAndReturnRemainingTokensCommand>

Field Summary

Fields

Modifier and Type	Field	Description
static SerializationHandle<TryConsumeAndReturnRemainingTokensCommand>	SERIALIZATION_HANDLE

Constructor Summary

Constructors

Constructor	Description
TryConsumeAndReturnRemainingTokensCommand(long tokensToConsume)

Method Summary

Modifier and Type	Method	Description
boolean	equalsByContent(TryConsumeAndReturnRemainingTokensCommand other)
long	estimateTokensToConsume()
CommandResult<ConsumptionProbe>	execute(MutableBucketEntry mutableEntry, long currentTimeNanos)
long	getConsumedTokens(ConsumptionProbe result)
Version	getRequiredVersion()
SerializationHandle	getSerializationHandle()
long	getTokensToConsume()
boolean	isImmediateSyncRequired(long unsynchronizedTokens, long nanosSinceLastSync)

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, getMergedCommandsCount, isInitializationCommand, isMerged, mergeInto, toMergedCommand, unwrapOneResult

Field Detail

SERIALIZATION_HANDLE

public static final SerializationHandle<TryConsumeAndReturnRemainingTokensCommand> SERIALIZATION_HANDLE

Constructor Detail

TryConsumeAndReturnRemainingTokensCommand

public TryConsumeAndReturnRemainingTokensCommand(long tokensToConsume)

Method Detail

execute

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

Specified by:

execute in interface RemoteCommand<ConsumptionProbe>

getTokensToConsume

public long getTokensToConsume()

getSerializationHandle

public SerializationHandle getSerializationHandle()

Specified by:

getSerializationHandle in interface RemoteCommand<ConsumptionProbe>

equalsByContent

public boolean equalsByContent(TryConsumeAndReturnRemainingTokensCommand other)

Specified by:

equalsByContent in interface ComparableByContent<TryConsumeAndReturnRemainingTokensCommand>

isImmediateSyncRequired

public boolean isImmediateSyncRequired(long unsynchronizedTokens,
                                       long nanosSinceLastSync)

Specified by:

isImmediateSyncRequired in interface RemoteCommand<ConsumptionProbe>

estimateTokensToConsume

public long estimateTokensToConsume()

Specified by:

estimateTokensToConsume in interface RemoteCommand<ConsumptionProbe>

getConsumedTokens

public long getConsumedTokens(ConsumptionProbe result)

Specified by:

getConsumedTokens in interface RemoteCommand<ConsumptionProbe>

getRequiredVersion

public Version getRequiredVersion()

Specified by:

getRequiredVersion in interface RemoteCommand<ConsumptionProbe>