Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
get_any_replica_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#include <couchbase/error.hxx>
24
25#include <functional>
26
27namespace couchbase
28{
35struct get_any_replica_options : public common_options<get_any_replica_options> {
42 struct built : public common_options<get_any_replica_options>::built {
44 };
45
58 {
59 read_preference_ = preference;
60 return self();
61 }
62
74 [[nodiscard]] auto build() const -> built
75 {
76 return {
78 read_preference_,
79 };
80 }
81
82private:
84};
85
92using get_any_replica_handler = std::function<void(error, get_replica_result)>;
93} // namespace couchbase
Common options that used by most operations.
Definition common_options.hxx:37
auto self() -> get_any_replica_options &
Definition common_options.hxx:102
auto build_common_options() const -> built
Definition common_options.hxx:89
Definition error.hxx:30
Represents result of collection::get_any_replica operations, also returned by collection::get_all_rep...
Definition get_replica_result.hxx:36
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
std::function< void(error, get_replica_result)> get_any_replica_handler
The signature for the handler of the collection::get_any_replica() operation.
Definition get_any_replica_options.hxx:92
read_preference
Select read preference (or affinity) for the replica APIs such as:
Definition read_preference.hxx:39
@ no_preference
Do not enforce any filtering for replica set.
Immutable value object representing consistent options.
Definition get_any_replica_options.hxx:42
couchbase::read_preference read_preference
Definition get_any_replica_options.hxx:43
Options for collection::get_any_replica().
Definition get_any_replica_options.hxx:35
auto read_preference(read_preference preference) -> get_any_replica_options &
Choose how the replica nodes will be selected.
Definition get_any_replica_options.hxx:57
auto build() const -> built
Validates options and returns them as an immutable value.
Definition get_any_replica_options.hxx:74