backoff.h

Go to the documentation of this file.

/*
 *
 * Copyright 2016 gRPC authors.
 *
 * 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.
 *
 */
 
#ifndef GRPC_CORE_LIB_BACKOFF_BACKOFF_H
#define GRPC_CORE_LIB_BACKOFF_BACKOFF_H
 
#include <grpc/support/port_platform.h>
 
#include "absl/random/random.h"
 
#include "src/core/lib/gprpp/time.h"
 
namespace grpc_core {
 
class BackOff {
 public:
  class Options;
 
  explicit BackOff(const Options& options);
 
  Timestamp NextAttemptTime();
 
  void Reset();
 
  class Options {
   public:
    Options& set_initial_backoff(Duration initial_backoff) {
      initial_backoff_ = initial_backoff;
      return *this;
    }
    Options& set_multiplier(double multiplier) {
      multiplier_ = multiplier;
      return *this;
    }
    Options& set_jitter(double jitter) {
      jitter_ = jitter;
      return *this;
    }
    Options& set_max_backoff(Duration max_backoff) {
      max_backoff_ = max_backoff;
      return *this;
    }
    Duration initial_backoff() const { return initial_backoff_; }
    double multiplier() const { return multiplier_; }
    double jitter() const { return jitter_; }
    Duration max_backoff() const { return max_backoff_; }
 
   private:
    Duration initial_backoff_;
    double multiplier_;
    double jitter_;
    Duration max_backoff_;
  };  // class Options
 
 private:
  const Options options_;
  absl::BitGen rand_gen_;
  bool initial_;
  Duration current_backoff_;
};
 
}  // namespace grpc_core
#endif /* GRPC_CORE_LIB_BACKOFF_BACKOFF_H */