layer.hpp

Go to the documentation of this file.

/*
 * 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.
 */
 
#pragma once
 
#include <chrono>
#include <cstdint>
#include <memory>
#include <vector>
 
namespace opendal {
 
class Operator;
 
namespace ffi {
class LayerBuilder;
}  // namespace ffi
 
class LayerBuilderMutator {
 public:
  virtual ~LayerBuilderMutator() = default;
 
  virtual void AddTimeout(uint64_t timeout_ns, uint64_t io_timeout_ns) = 0;
  virtual void AddRetry(bool jitter, float factor, uint64_t min_delay_ns,
                        uint64_t max_delay_ns, uint64_t max_times) = 0;
};
 
class FfiLayerBuilderMutator final : public LayerBuilderMutator {
 public:
  explicit FfiLayerBuilderMutator(ffi::LayerBuilder &builder);
 
  void AddTimeout(uint64_t timeout_ns, uint64_t io_timeout_ns) override;
  void AddRetry(bool jitter, float factor, uint64_t min_delay_ns,
                uint64_t max_delay_ns, uint64_t max_times) override;
 
 private:
  ffi::LayerBuilder &builder_;
};
 
struct RetryConfig {
  bool jitter = false;
  float factor = 2.0f;
  std::chrono::nanoseconds min_delay{std::chrono::seconds(1)};
  std::chrono::nanoseconds max_delay{std::chrono::minutes(1)};
  uint64_t max_times = 3;
};
 
class OperatorOption {
 public:
  virtual ~OperatorOption() = default;
 
  void ApplyTo(LayerBuilderMutator &builder) const { Apply(builder); }
 
 protected:
  friend class Operator;
  virtual void Apply(LayerBuilderMutator &builder) const = 0;
};
 
std::unique_ptr<OperatorOption> WithTimeout(
    std::chrono::nanoseconds timeout, std::chrono::nanoseconds io_timeout);
 
std::unique_ptr<OperatorOption> WithRetry(RetryConfig config = {});
 
std::vector<std::unique_ptr<OperatorOption>> DefaultBehaviorLayerOptions();
 
}  // namespace opendal