transactions_config.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *     Copyright 2021-Present Couchbase, Inc.
 *
 *   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.
 */
#pragma once
 
#include <couchbase/durability_level.hxx>
#include <couchbase/transactions/transaction_keyspace.hxx>
#include <couchbase/transactions/transactions_cleanup_config.hxx>
#include <couchbase/transactions/transactions_query_config.hxx>
 
#include <chrono>
#include <memory>
#include <optional>
 
namespace couchbase::core::transactions
{
struct attempt_context_testing_hooks;

struct cleanup_testing_hooks;
} // namespace couchbase::core::transactions
 
namespace couchbase::transactions
{
class transactions_config
{
public:
  transactions_config();
 
  ~transactions_config();
 
  transactions_config(const transactions_config& c);
 
  auto operator=(const transactions_config& c) -> transactions_config&;
 
  // No move operations are declared: they fall back to the copy operations, which is sufficient for
  // this configuration object (copied once during transaction setup) and keeps a moved-from source
  // valid -- the hook accessors dereference their pointers, so a nulled-out source would be unsafe.

  [[nodiscard]] auto durability_level() const -> couchbase::durability_level
  {
    return level_;
  }

  auto durability_level(enum couchbase::durability_level level) -> transactions_config&
  {
    level_ = level;
    return *this;
  }

  [[nodiscard]] auto timeout() const -> std::chrono::nanoseconds
  {
    return timeout_;
  }

  template<typename T>
  auto timeout(T duration) -> transactions_config&
  {
    timeout_ = std::chrono::duration_cast<std::chrono::nanoseconds>(duration);
    return *this;
  }

  auto metadata_collection(const couchbase::transactions::transaction_keyspace& keyspace)
    -> transactions_config&
  {
    metadata_collection_ = keyspace;
    return *this;
  }
 
  [[nodiscard]] auto metadata_collection() const
    -> std::optional<couchbase::transactions::transaction_keyspace>
  {
    return metadata_collection_;
  }

  [[nodiscard]] auto query_config() const -> const transactions_query_config&
  {
    return query_config_;
  }

  [[nodiscard]] auto query_config() -> transactions_query_config&
  {
    return query_config_;
  }

  auto query_config(const transactions_query_config& config) -> transactions_config&
  {
    query_config_ = config;
    return *this;
  }

  [[nodiscard]] auto cleanup_config() const -> const transactions_cleanup_config&
  {
    return cleanup_config_;
  }

  [[nodiscard]] auto cleanup_config() -> transactions_cleanup_config&
  {
    return cleanup_config_;
  }

  auto cleanup_config(const transactions_cleanup_config& cleanup_config) -> transactions_config&
  {
    cleanup_config_ = cleanup_config;
    return *this;
  }

  auto test_factories(std::shared_ptr<core::transactions::attempt_context_testing_hooks> hooks,
                      std::shared_ptr<core::transactions::cleanup_testing_hooks> cleanup_hooks)
    -> transactions_config&
  {
    attempt_context_hooks_ = hooks;
    cleanup_hooks_ = cleanup_hooks;
    return *this;
  }

  [[nodiscard]] auto attempt_context_hooks() const
    -> core::transactions::attempt_context_testing_hooks&
  {
    return *attempt_context_hooks_;
  }

  [[nodiscard]] auto cleanup_hooks() const -> core::transactions::cleanup_testing_hooks&
  {
    return *cleanup_hooks_;
  }

  struct built {
    couchbase::durability_level level;
    std::chrono::nanoseconds timeout;
    std::shared_ptr<core::transactions::attempt_context_testing_hooks> attempt_context_hooks;
    std::shared_ptr<core::transactions::cleanup_testing_hooks> cleanup_hooks;
    std::optional<couchbase::transactions::transaction_keyspace> metadata_collection;
    transactions_query_config::built query_config;
    transactions_cleanup_config::built cleanup_config;
  };

  [[nodiscard]] auto build() const -> built;
 
private:
  couchbase::durability_level level_{ couchbase::durability_level::majority };
  std::chrono::nanoseconds timeout_{ std::chrono::seconds(15) };
  std::shared_ptr<core::transactions::attempt_context_testing_hooks> attempt_context_hooks_;
  std::shared_ptr<core::transactions::cleanup_testing_hooks> cleanup_hooks_;
  std::optional<couchbase::transactions::transaction_keyspace> metadata_collection_;
  transactions_query_config query_config_{};
  transactions_cleanup_config cleanup_config_{};
};
} // namespace couchbase::transactions