Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
ping_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 2023-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
23
24#include <functional>
25#include <memory>
26#include <optional>
27#include <set>
28#include <string>
29
30namespace couchbase
31{
32struct ping_options : public common_options<ping_options> {
43 auto report_id(std::string report_id) -> ping_options&
44 {
45 report_id_ = std::move(report_id);
46 return self();
47 }
48
55 auto service_types(std::set<service_type> service_types) -> ping_options&
56 {
57 service_types_ = std::move(service_types);
58 return self();
59 }
60
67 struct built : public common_options<ping_options>::built {
68 std::optional<std::string> report_id;
69 std::set<service_type> service_types;
70 };
71
83 [[nodiscard]] auto build() const -> built
84 {
85 return { build_common_options(), report_id_, service_types_ };
86 }
87
88private:
89 std::optional<std::string> report_id_{};
90 std::set<service_type> service_types_{};
91};
92
93using ping_handler = std::function<void(error, ping_result)>;
94} // namespace couchbase
Common options that used by most operations.
Definition common_options.hxx:37
auto self() -> ping_options &
Definition common_options.hxx:102
auto build_common_options() const -> built
Definition common_options.hxx:89
Definition error.hxx:30
Definition ping_result.hxx:32
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
std::function< void(error, ping_result)> ping_handler
Definition ping_options.hxx:93
Immutable value object representing consistent options.
Definition ping_options.hxx:67
std::optional< std::string > report_id
Definition ping_options.hxx:68
std::set< service_type > service_types
Definition ping_options.hxx:69
Definition ping_options.hxx:32
auto service_types(std::set< service_type > service_types) -> ping_options &
Customizes the set of services to ping.
Definition ping_options.hxx:55
auto build() const -> built
Validates the options and returns them as an immutable value.
Definition ping_options.hxx:83
auto report_id(std::string report_id) -> ping_options &
Sets a custom report ID that will be used in the report.
Definition ping_options.hxx:43