org.spf4j.base.CallablesNano Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spf4j-core Show documentation
A continuously growing collection of utilities to measure performance, get better diagnostics, improve performance, or do things more reliably, faster that other open source libraries...
The newest version!
/*
 * Copyright (c) 2001-2017, Zoltan Farkas All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Additionally licensed with:
 *
 * 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.
 */
package org.spf4j.base;

import com.google.common.annotations.Beta;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.concurrent.Callable;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import javax.annotation.ParametersAreNonnullByDefault;
import org.spf4j.base.Callables.AdvancedRetryPredicate;
import static org.spf4j.base.Callables.DEFAULT_EXCEPTION_RETRY;
import org.spf4j.base.Callables.FibonacciBackoffRetryPredicate;
import org.spf4j.base.Callables.TimeoutCallable;
import org.spf4j.base.Callables.TimeoutRetryPredicate2RetryPredicate;
import org.spf4j.base.Callables.TimeoutRetryPredicate;

/**
 * Utility class for executing stuff with retry logic.
 *
 * @author zoly
 * @deprecated use RetryPolicy & co.
 */
@ParametersAreNonnullByDefault
@Beta
@Deprecated
@SuppressFBWarnings("AI_ANNOTATION_ISSUES_NEEDS_NULLABLE")
//CHECKSTYLE IGNORE RedundantThrows FOR NEXT 2000 LINES
public final class CallablesNano {

  private CallablesNano() {
  }

  public static  T executeWithRetry(final NanoTimeoutCallable what,
          final int nrImmediateRetries,
          final long maxRetryWaitNanos, final Class exceptionClass)
          throws InterruptedException, EX, TimeoutException {
    return executeWithRetry(what, nrImmediateRetries, maxRetryWaitNanos,
            (TimeoutNanoRetryPredicate) TimeoutNanoRetryPredicate.NORETRY_FOR_RESULT,
            DEFAULT_EXCEPTION_RETRY, exceptionClass);
  }

  public static  T executeWithRetry(final NanoTimeoutCallable what,
          final int nrImmediateRetries,
          final long maxRetryWaitNanos,
          final AdvancedRetryPredicate retryOnException,
          final Class exceptionClass)
          throws InterruptedException, EX, TimeoutException {
    return executeWithRetry(what, nrImmediateRetries, maxRetryWaitNanos,
            (TimeoutNanoRetryPredicate) TimeoutNanoRetryPredicate.NORETRY_FOR_RESULT,
            retryOnException, exceptionClass);
  }

  /**
   * After the immediate retries are done, delayed retry with randomized Fibonacci values up to the specified max is
   * executed.
   *
   * @param  - the type returned by the Callable that is retried.
   * @param  - the Exception thrown by the retried callable.
   * @param what - the callable to retry.
   * @param nrImmediateRetries - the number of immediate retries.
   * @param maxWaitNanos - maximum wait time in between retries.
   * @param retryOnReturnVal - predicate to control retry on return value;
   * @param retryOnException - predicate to retry on thrown exception.
   * @return the result of the callable.
   * @throws java.lang.InterruptedException - thrown if interrupted.
   * @throws EX - the exception declared to be thrown by the callable.
   */
  public static  T executeWithRetry(final NanoTimeoutCallable what,
          final int nrImmediateRetries, final long maxWaitNanos,
          final TimeoutNanoRetryPredicate retryOnReturnVal,
          final AdvancedRetryPredicate retryOnException,
          final Class exceptionClass)
          throws InterruptedException, EX, TimeoutException {
    final long deadline = what.getDeadline();
    return Callables.executeWithRetry(what, new TimeoutRetryPredicate2RetryPredicate<>(deadline, retryOnReturnVal),
            new FibonacciBackoffRetryPredicate<>(retryOnException, nrImmediateRetries,
                    maxWaitNanos / 100, maxWaitNanos, Callables::rootClass, deadline,
                    () -> TimeSource.nanoTime(), TimeUnit.NANOSECONDS), exceptionClass);
  }

  public static long toDeadlineNanos(final long timeoutNanos) {
    long nanoTime = TimeSource.nanoTime();
    return Callables.overflowSafeAdd(nanoTime, timeoutNanos);
  }

  public abstract static class NanoTimeoutCallable extends TimeoutCallable {

    public NanoTimeoutCallable(final long timeoutNanos) {
      super(toDeadlineNanos(timeoutNanos));
    }

    /**
     * @param deadline System.nanoTime deadline.
     */
    public abstract T call(long deadline) throws EX, InterruptedException, TimeoutException;

  }

  public static  T executeWithRetry(final NanoTimeoutCallable what,
          final TimeoutNanoRetryPredicate retryOnReturnVal,
          final TimeoutNanoRetryPredicate retryOnException,
          final Class exceptionClass)
          throws InterruptedException, EX, TimeoutException {
    return Callables.executeWithRetry(what, retryOnReturnVal, retryOnException, exceptionClass);
  }

  public static  T executeWithRetry(final NanoTimeoutCallable what,
          final TimeoutNanoRetryPredicate retryOnException, final Class exceptionClass)
          throws InterruptedException, EX, TimeoutException {
    return Callables.executeWithRetry(what,
            (TimeoutRetryPredicate) TimeoutRetryPredicate.NORETRY_FOR_RESULT,
            retryOnException, exceptionClass);
  }

  public interface TimeoutNanoRetryPredicate extends TimeoutRetryPredicate {

    @Override
    Callables.RetryDecision getDecision(T value, long deadlineNanos, Callable what);

    TimeoutNanoRetryPredicate NORETRY_FOR_RESULT = new TimeoutNanoRetryPredicate() {

      @Override
      public Callables.RetryDecision