org.apache.rocketmq.client.java.retry.ExponentialBackoffRetryPolicy Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package org.apache.rocketmq.client.java.retry;
import static apache.rocketmq.v2.RetryPolicy.StrategyCase.EXPONENTIAL_BACKOFF;
import static org.apache.rocketmq.shaded.com.google.common.base.Preconditions.checkArgument;
import apache.rocketmq.v2.ExponentialBackoff;
import org.apache.rocketmq.shaded.com.google.common.base.MoreObjects;
import org.apache.rocketmq.shaded.com.google.protobuf.util.Durations;
import java.time.Duration;
/**
* The {@link ExponentialBackoffRetryPolicy} defines a policy to do more attempts when failure is encountered.
*/
public class ExponentialBackoffRetryPolicy implements RetryPolicy {
private final int maxAttempts;
private final Duration initialBackoff;
private final Duration maxBackoff;
private final double backoffMultiplier;
/**
* The caller is supposed to have validated the arguments and handled throwing exception or
* logging warnings already, so we avoid repeating args check here.
*/
public ExponentialBackoffRetryPolicy(int maxAttempts, Duration initialBackoff, Duration maxBackoff,
double backoffMultiplier) {
this.maxAttempts = maxAttempts;
this.initialBackoff = initialBackoff;
this.maxBackoff = maxBackoff;
this.backoffMultiplier = backoffMultiplier;
}
public static ExponentialBackoffRetryPolicy immediatelyRetryPolicy(int maxAttempts) {
return new ExponentialBackoffRetryPolicy(maxAttempts, Duration.ZERO, Duration.ZERO, 1);
}
@Override
public int getMaxAttempts() {
return maxAttempts;
}
@Override
public Duration getNextAttemptDelay(int attempt) {
checkArgument(attempt > 0, "attempt must be positive");
double delayNanos = Math.min(initialBackoff.toNanos() * Math.pow(backoffMultiplier,
1.0 * (attempt - 1)), maxBackoff.toNanos());
if (delayNanos <= 0) {
return Duration.ZERO;
}
return Duration.ofNanos((long) delayNanos);
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("maxAttempts", maxAttempts)
.add("initialBackoff", initialBackoff)
.add("maxBackoff", maxBackoff)
.add("backoffMultiplier", backoffMultiplier)
.toString();
}
public static ExponentialBackoffRetryPolicy fromProtobuf(apache.rocketmq.v2.RetryPolicy retryPolicy) {
if (!EXPONENTIAL_BACKOFF.equals(retryPolicy.getStrategyCase())) {
throw new IllegalArgumentException();
}
final ExponentialBackoff exponentialBackoff = retryPolicy.getExponentialBackoff();
return new ExponentialBackoffRetryPolicy(retryPolicy.getMaxAttempts(),
Duration.ofNanos(Durations.toNanos(exponentialBackoff.getInitial())),
Duration.ofNanos(Durations.toNanos(exponentialBackoff.getMax())),
exponentialBackoff.getMultiplier());
}
@Override
public RetryPolicy updateBackoff(apache.rocketmq.v2.RetryPolicy retryPolicy) {
if (!EXPONENTIAL_BACKOFF.equals(retryPolicy.getStrategyCase())) {
throw new IllegalArgumentException("strategy must be exponential backoff");
}
return updateBackoff(retryPolicy.getExponentialBackoff());
}
private RetryPolicy updateBackoff(ExponentialBackoff backoff) {
return new ExponentialBackoffRetryPolicy(maxAttempts,
Duration.ofNanos(Durations.toNanos(backoff.getInitial())),
Duration.ofNanos(Durations.toNanos(backoff.getMax())),
backoff.getMultiplier());
}
@Override
public apache.rocketmq.v2.RetryPolicy toProtobuf() {
ExponentialBackoff exponentialBackoff = ExponentialBackoff.newBuilder()
.setMultiplier((float) backoffMultiplier)
.setMax(Durations.fromNanos(maxBackoff.toNanos()))
.setInitial(Durations.fromNanos(initialBackoff.toNanos()))
.build();
return apache.rocketmq.v2.RetryPolicy.newBuilder()
.setMaxAttempts(maxAttempts)
.setExponentialBackoff(exponentialBackoff)
.build();
}
}