Module io.github.bucket4j.core

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

Class ConsumeIgnoringRateLimitsCommand

java.lang.Object

io.github.bucket4j.distributed.remote.commands.ConsumeIgnoringRateLimitsCommand

All Implemented Interfaces:

RemoteCommand<Long>, ComparableByContent<ConsumeIgnoringRateLimitsCommand>

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

Field Summary

Fields

Modifier and Type	Field	Description
static final SerializationHandle<ConsumeIgnoringRateLimitsCommand>	SERIALIZATION_HANDLE

Constructor Summary

Constructors

Constructor	Description
ConsumeIgnoringRateLimitsCommand(long limit)

Method Summary

Modifier and Type	Method	Description
boolean	equalsByContent(ConsumeIgnoringRateLimitsCommand other)
long	estimateTokensToConsume()
CommandResult<Long>	execute(MutableBucketEntry mutableEntry, long currentTimeNanos)
long	getConsumedTokens(Long result)
Version	getRequiredVersion()
SerializationHandle<RemoteCommand<?>>	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 Details

SERIALIZATION_HANDLE

public static final SerializationHandle<ConsumeIgnoringRateLimitsCommand> SERIALIZATION_HANDLE

Constructor Details

ConsumeIgnoringRateLimitsCommand

public ConsumeIgnoringRateLimitsCommand(long limit)

Method Details

getTokensToConsume

public long getTokensToConsume()

execute

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

Specified by:

execute in interface RemoteCommand<Long>

getSerializationHandle

public SerializationHandle<RemoteCommand<?>> getSerializationHandle()

Specified by:

getSerializationHandle in interface RemoteCommand<Long>

equalsByContent

public boolean equalsByContent(ConsumeIgnoringRateLimitsCommand other)

Specified by:

equalsByContent in interface ComparableByContent<ConsumeIgnoringRateLimitsCommand>

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>