MongoDB C++ Driver  mongocxx-3.3.2
All Classes Namespaces Functions Enumerations Enumerator Friends Pages
write_concern.hpp
1 // Copyright 2014 MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <chrono>
18 #include <cstdint>
19 #include <memory>
20 #include <stdexcept>
21 
22 #include <bsoncxx/document/value.hpp>
23 #include <bsoncxx/stdx/optional.hpp>
24 #include <bsoncxx/stdx/string_view.hpp>
25 #include <mongocxx/stdx.hpp>
26 
27 #include <mongocxx/config/prelude.hpp>
28 
29 namespace mongocxx {
30 MONGOCXX_INLINE_NAMESPACE_BEGIN
31 
32 class bulk_write;
33 class client;
34 class collection;
35 class database;
36 class uri;
37 
55 class MONGOCXX_API write_concern {
56  public:
61  enum class level { k_default, k_majority, k_tag, k_unacknowledged, k_acknowledged };
62 
66  write_concern();
67 
72 
76  write_concern& operator=(const write_concern&);
77 
81  write_concern(write_concern&&) noexcept;
82 
86  write_concern& operator=(write_concern&&) noexcept;
87 
91  ~write_concern();
92 
101  void journal(bool journal);
102 
118  void nodes(std::int32_t confirm_from);
119 
138  void acknowledge_level(level confirm_level);
139 
150  void majority(std::chrono::milliseconds timeout);
151 
161  void tag(stdx::string_view tag);
162 
173  void timeout(std::chrono::milliseconds timeout);
174 
180  bool journal() const;
181 
192  stdx::optional<std::int32_t> nodes() const;
193 
201  level acknowledge_level() const;
202 
208  stdx::optional<std::string> tag() const;
209 
215  bool majority() const;
216 
222  std::chrono::milliseconds timeout() const;
223 
229  bool is_acknowledged() const;
230 
237  bsoncxx::document::value to_document() const;
238 
239  private:
240  friend bulk_write;
241  friend client;
242  friend collection;
243  friend database;
244  friend uri;
245 
253  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const write_concern&, const write_concern&);
254  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const write_concern&, const write_concern&);
258 
259  class MONGOCXX_PRIVATE impl;
260 
261  MONGOCXX_PRIVATE write_concern(std::unique_ptr<impl>&& implementation);
262 
263  std::unique_ptr<impl> _impl;
264 };
265 
266 MONGOCXX_INLINE_NAMESPACE_END
267 } // namespace mongocxx
268 
269 #include <mongocxx/config/postlude.hpp>
Class representing a MongoDB connection string URI.
Definition: uri.hpp:40
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
A read-only BSON document that owns its underlying buffer.
Definition: value.hpp:33
Class representing a client connection to MongoDB.
Definition: client.hpp:57
Class representing a MongoDB database.
Definition: database.hpp:47
level
A class to represent the special case values for write_concern::nodes.
Definition: write_concern.hpp:61
Class representing a batch of write operations that can be sent to the server as a group...
Definition: bulk_write.hpp:43
Class representing the server-side requirement for reporting the success of a write operation...
Definition: write_concern.hpp:55
Class representing server side document groupings within a MongoDB database.
Definition: collection.hpp:87