MongoDB C++ Driver  mongocxx-3.7.0
client_session.hpp
1 // Copyright 2017-present 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 <bsoncxx/stdx/optional.hpp>
18 #include <mongocxx/options/transaction.hpp>
19 #include <mongocxx/stdx.hpp>
20 
21 #include <mongocxx/config/prelude.hpp>
22 
23 namespace mongocxx {
24 MONGOCXX_INLINE_NAMESPACE_BEGIN
25 namespace options {
26 
30 class MONGOCXX_API client_session {
31  public:
50  client_session& causal_consistency(bool causal_consistency) noexcept;
51 
56  bool causal_consistency() const noexcept;
57 
72  client_session& snapshot(bool enable_snapshot_reads) noexcept;
73 
77  bool snapshot() const noexcept;
78 
89  client_session& default_transaction_opts(transaction default_transaction_opts);
90 
96  const stdx::optional<transaction>& default_transaction_opts() const;
97 
98  private:
99  // Allow the implementation of client_session to see these:
101 
102  stdx::optional<bool> _causal_consistency;
103  stdx::optional<bool> _enable_snapshot_reads;
104 
105  stdx::optional<transaction> _default_transaction_opts;
106 };
107 
108 } // namespace options
109 MONGOCXX_INLINE_NAMESPACE_END
110 } // namespace mongocxx
111 
112 #include <mongocxx/config/postlude.hpp>
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
mongocxx::options::client_session
Class representing the optional arguments to mongocxx::client::start_session.
Definition: client_session.hpp:30
mongocxx::client_session
Use a session for a sequence of operations, optionally with either causal consistency or snapshots.
Definition: client_session.hpp:40
mongocxx::options::transaction
Class representing the optional arguments for a transaction.
Definition: transaction.hpp:38