Couchbase C++ SDK 1.0.1 (rev. 58d46d7)
Loading...
Searching...
No Matches
common_options.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/*
3 * Copyright 2020-Present Couchbase, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#pragma once
19
21
22#include <chrono>
23#include <memory>
24#include <optional>
25#include <type_traits>
26
27namespace couchbase
28{
35template<typename derived_class>
37{
38public:
51 auto timeout(const std::chrono::milliseconds timeout) -> derived_class&
52 {
53 timeout_ = timeout;
54 return self();
55 }
56
66 auto retry_strategy(const std::shared_ptr<retry_strategy> strategy) -> derived_class&
67 {
68 retry_strategy_ = strategy;
69 return self();
70 }
71
78 struct built {
79 const std::optional<std::chrono::milliseconds> timeout;
80 const std::shared_ptr<couchbase::retry_strategy> retry_strategy;
81 };
82
83protected:
89 [[nodiscard]] auto build_common_options() const -> built
90 {
91 return { timeout_, retry_strategy_ };
92 }
93
102 auto self() -> derived_class&
103 {
104 return *static_cast<derived_class*>(this);
105 }
106
107private:
108 std::optional<std::chrono::milliseconds> timeout_{};
109 std::shared_ptr<couchbase::retry_strategy> retry_strategy_{ nullptr };
110};
111
112} // namespace couchbase
Common options that used by most operations.
Definition common_options.hxx:37
auto retry_strategy(const std::shared_ptr< retry_strategy > strategy) -> derived_class &
Specifies a custom couchbase::retry_strategy for this operation.
Definition common_options.hxx:66
auto self() -> derived_class &
Allows to return the right options builder instance for child implementations.
Definition common_options.hxx:102
auto timeout(const std::chrono::milliseconds timeout) -> derived_class &
Specifies a custom per-operation timeout.
Definition common_options.hxx:51
auto build_common_options() const -> built
Definition common_options.hxx:89
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
Immutable value object representing consistent options.
Definition common_options.hxx:78
const std::optional< std::chrono::milliseconds > timeout
Definition common_options.hxx:79
const std::shared_ptr< couchbase::retry_strategy > retry_strategy
Definition common_options.hxx:80