io.github.bucket4j.distributed.remote.commands.TryConsumeAndReturnRemainingTokensCommand Maven / Gradle / Ivy
The newest version!
/*-
* ========================LICENSE_START=================================
* Bucket4j
* %%
* Copyright (C) 2015 - 2020 Vladimir Bukhtoyarov
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* =========================LICENSE_END==================================
*/
package io.github.bucket4j.distributed.remote.commands;
import io.github.bucket4j.ConsumptionProbe;
import io.github.bucket4j.distributed.serialization.DeserializationAdapter;
import io.github.bucket4j.distributed.serialization.Scope;
import io.github.bucket4j.distributed.serialization.SerializationAdapter;
import io.github.bucket4j.distributed.serialization.SerializationHandle;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import io.github.bucket4j.distributed.remote.CommandResult;
import io.github.bucket4j.distributed.remote.MutableBucketEntry;
import io.github.bucket4j.distributed.remote.RemoteBucketState;
import io.github.bucket4j.distributed.remote.RemoteCommand;
import io.github.bucket4j.distributed.versioning.Version;
import io.github.bucket4j.distributed.versioning.Versions;
import io.github.bucket4j.util.ComparableByContent;
import static io.github.bucket4j.distributed.versioning.Versions.v_7_0_0;
public class TryConsumeAndReturnRemainingTokensCommand implements RemoteCommand, ComparableByContent {
private final long tokensToConsume;
public static final SerializationHandle SERIALIZATION_HANDLE = new SerializationHandle<>() {
@Override
public TryConsumeAndReturnRemainingTokensCommand deserialize(DeserializationAdapter adapter, S input) throws IOException {
int formatNumber = adapter.readInt(input);
Versions.check(formatNumber, v_7_0_0, v_7_0_0);
long tokensToConsume = adapter.readLong(input);
return new TryConsumeAndReturnRemainingTokensCommand(tokensToConsume);
}
@Override
public void serialize(SerializationAdapter adapter, O output, TryConsumeAndReturnRemainingTokensCommand command, Version backwardCompatibilityVersion, Scope scope) throws IOException {
adapter.writeInt(output, v_7_0_0.getNumber());
adapter.writeLong(output, command.tokensToConsume);
}
@Override
public int getTypeId() {
return 30;
}
@Override
public Class getSerializedType() {
return TryConsumeAndReturnRemainingTokensCommand.class;
}
@Override
public TryConsumeAndReturnRemainingTokensCommand fromJsonCompatibleSnapshot(Map snapshot) {
int formatNumber = readIntValue(snapshot, "version");
Versions.check(formatNumber, v_7_0_0, v_7_0_0);
long tokensToConsume = readLongValue(snapshot, "tokensToConsume");
return new TryConsumeAndReturnRemainingTokensCommand(tokensToConsume);
}
@Override
public Map toJsonCompatibleSnapshot(TryConsumeAndReturnRemainingTokensCommand command, Version backwardCompatibilityVersion, Scope scope) {
Map result = new HashMap<>();
result.put("version", v_7_0_0.getNumber());
result.put("tokensToConsume", command.tokensToConsume);
return result;
}
@Override
public String getTypeName() {
return "TryConsumeAndReturnRemainingTokensCommand";
}
};
public TryConsumeAndReturnRemainingTokensCommand(long tokensToConsume) {
this.tokensToConsume = tokensToConsume;
}
@Override
public CommandResult execute(MutableBucketEntry mutableEntry, long currentTimeNanos) {
if (!mutableEntry.exists()) {
return CommandResult.bucketNotFound();
}
RemoteBucketState state = mutableEntry.get();
state.refillAllBandwidth(currentTimeNanos);
long availableToConsume = state.getAvailableTokens();
if (tokensToConsume <= availableToConsume) {
state.consume(tokensToConsume);
mutableEntry.set(state);
long nanosToWaitForReset = state.calculateFullRefillingTime(currentTimeNanos);
long remainingTokens = availableToConsume - tokensToConsume;
ConsumptionProbe probe = ConsumptionProbe.consumed(remainingTokens, nanosToWaitForReset);
return CommandResult.success(probe, ConsumptionProbe.SERIALIZATION_HANDLE);
} else {
long nanosToWaitForReset = state.calculateFullRefillingTime(currentTimeNanos);
long nanosToWaitForRefill = state.calculateDelayNanosAfterWillBePossibleToConsume(tokensToConsume, currentTimeNanos, true);
ConsumptionProbe probe = ConsumptionProbe.rejected(availableToConsume, nanosToWaitForRefill, nanosToWaitForReset);
return CommandResult.success(probe, ConsumptionProbe.SERIALIZATION_HANDLE);
}
}
public long getTokensToConsume() {
return tokensToConsume;
}
@Override
public SerializationHandle getSerializationHandle() {
return SERIALIZATION_HANDLE;
}
@Override
public boolean equalsByContent(TryConsumeAndReturnRemainingTokensCommand other) {
return tokensToConsume == other.tokensToConsume;
}
@Override
public boolean isImmediateSyncRequired(long unsynchronizedTokens, long nanosSinceLastSync) {
return false;
}
@Override
public long estimateTokensToConsume() {
return tokensToConsume;
}
@Override
public long getConsumedTokens(ConsumptionProbe result) {
return result.isConsumed() ? tokensToConsume : 0L;
}
@Override
public Version getRequiredVersion() {
return v_7_0_0;
}
}