Module io.github.bucket4j.core

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

Class TryConsumeCommand

java.lang.Object

io.github.bucket4j.distributed.remote.commands.TryConsumeCommand

All Implemented Interfaces:

RemoteCommand<Boolean>, ComparableByContent<TryConsumeCommand>

public class TryConsumeCommand
extends Object
implements RemoteCommand<Boolean>, ComparableByContent<TryConsumeCommand>

Field Summary

Fields

Modifier and Type	Field	Description
static SerializationHandle<TryConsumeCommand>	SERIALIZATION_HANDLE
static TryConsumeCommand	TRY_CONSUME_ONE

Method Summary

Modifier and Type	Method	Description
boolean	canBeMerged(RemoteCommand<?> another)
static TryConsumeCommand	create(long tokensToConsume)
boolean	equalsByContent(TryConsumeCommand other)
long	estimateTokensToConsume()
CommandResult<Boolean>	execute(MutableBucketEntry mutableEntry, long currentTimeNanos)
long	getConsumedTokens(Boolean result)
Version	getRequiredVersion()
SerializationHandle	getSerializationHandle()
long	getTokensToConsume()
boolean	isImmediateSyncRequired(long unsynchronizedTokens, long nanosSinceLastSync)
void	mergeInto(RemoteCommand<?> mergedCommand)
RemoteCommand<?>	toMergedCommand()

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

Field Detail

TRY_CONSUME_ONE

public static final TryConsumeCommand TRY_CONSUME_ONE

SERIALIZATION_HANDLE

public static final SerializationHandle<TryConsumeCommand> SERIALIZATION_HANDLE

Method Detail

toMergedCommand

public RemoteCommand<?> toMergedCommand()

Specified by:

toMergedCommand in interface RemoteCommand<Boolean>

canBeMerged

public boolean canBeMerged(RemoteCommand<?> another)

Specified by:

canBeMerged in interface RemoteCommand<Boolean>

mergeInto

public void mergeInto(RemoteCommand<?> mergedCommand)

Specified by:

mergeInto in interface RemoteCommand<Boolean>

create

public static TryConsumeCommand create(long tokensToConsume)

execute

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

Specified by:

execute in interface RemoteCommand<Boolean>

getTokensToConsume

public long getTokensToConsume()

getSerializationHandle

public SerializationHandle getSerializationHandle()

Specified by:

getSerializationHandle in interface RemoteCommand<Boolean>

equalsByContent

public boolean equalsByContent(TryConsumeCommand other)

Specified by:

equalsByContent in interface ComparableByContent<TryConsumeCommand>

isImmediateSyncRequired

public boolean isImmediateSyncRequired(long unsynchronizedTokens,
                                       long nanosSinceLastSync)

Specified by:

isImmediateSyncRequired in interface RemoteCommand<Boolean>

estimateTokensToConsume

public long estimateTokensToConsume()

Specified by:

estimateTokensToConsume in interface RemoteCommand<Boolean>

getConsumedTokens

public long getConsumedTokens(Boolean result)

Specified by:

getConsumedTokens in interface RemoteCommand<Boolean>

getRequiredVersion

public Version getRequiredVersion()

Specified by:

getRequiredVersion in interface RemoteCommand<Boolean>