mongo-csharp-driver/src/MongoDB.Driver/Core/Bindings/CoreSessionOptions.cs at 9c9880c684c527d501d86657441f3b99072f257f · papafe/mongo-csharp-driver · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/* Copyright 2018-present MongoDB Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

using MongoDB.Bson;
using MongoDB.Driver.Core.Misc;

namespace MongoDB.Driver.Core.Bindings
{
    /// <summary>
    /// Core session options.
    /// </summary>
    public class CoreSessionOptions
    {
        // private fields
        private readonly TransactionOptions _defaultTransactionOptions;
        private readonly bool _isCausallyConsistent;
        private readonly bool _isImplicit;
        private readonly bool _isSnapshot;
        private readonly BsonTimestamp _snapshotTime;

        // constructors
        /// <summary>
        /// Initializes a new instance of the <see cref="CoreSessionOptions" /> class.
        /// </summary>
        /// <param name="isCausallyConsistent">if set to <c>true</c> this session is causally consistent</param>
        /// <param name="isImplicit">if set to <c>true</c> this session is an implicit session.</param>
        /// <param name="isSnapshot">if set to <c>true</c> this session is a snapshot session.</param>
        /// <param name="defaultTransactionOptions">The default transaction options.</param>
        /// <param name="snapshotTime">The snapshot time. If this is set, isSnapshot must be true.</param>
        public CoreSessionOptions(
            bool isCausallyConsistent = false,
            bool isImplicit = false,
            TransactionOptions defaultTransactionOptions = null,
            bool isSnapshot = false,
            BsonTimestamp snapshotTime = null)
        {
            _isCausallyConsistent = isCausallyConsistent;
            _isImplicit = isImplicit;
            _isSnapshot = isSnapshot;
            _defaultTransactionOptions = defaultTransactionOptions;
            _snapshotTime = snapshotTime;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="CoreSessionOptions" /> class.
        /// </summary>
        /// <param name="isCausallyConsistent">if set to <c>true</c> this session is causally consistent</param>
        /// <param name="isImplicit">if set to <c>true</c> this session is an implicit session.</param>
        /// <param name="isSnapshot">if set to <c>true</c> this session is a snapshot session.</param>
        /// <param name="defaultTransactionOptions">The default transaction options.</param>
        public CoreSessionOptions(
            bool isCausallyConsistent,
            bool isImplicit,
            TransactionOptions defaultTransactionOptions,
            bool isSnapshot)
        : this(isCausallyConsistent, isImplicit, defaultTransactionOptions, isSnapshot, null)
        {
        }

        // public properties
        /// <summary>
        /// Gets the default transaction options.
        /// </summary>
        /// <value>
        /// The default transaction options.
        /// </value>
        public TransactionOptions DefaultTransactionOptions => _defaultTransactionOptions;

        /// <summary>
        /// Gets a value indicating whether this session is causally consistent.
        /// </summary>
        /// <value>
        ///   <c>true</c> if this session is causally consistent; otherwise, <c>false</c>.
        /// </value>
        public bool IsCausallyConsistent => _isCausallyConsistent;

        /// <summary>
        /// Gets a value indicating whether this session is an implicit session.
        /// </summary>
        /// <value>
        ///   <c>true</c> if this session is an implicit session; otherwise, <c>false</c>.
        /// </value>
        public bool IsImplicit => _isImplicit;

        /// <summary>
        /// Gets a value indicating whether this session is a snapshot session.
        /// </summary>
        /// <value>
        ///   <c>true</c> if this session is a snapshot session; otherwise, <c>false</c>.
        /// </value>
        public bool IsSnapshot => _isSnapshot;

        /// <summary>
        /// Gets the snapshot time for snapshot sessions.
        /// </summary>
        /// <value>
        /// The snapshot time as a <see cref="BsonTimestamp"/>, or <c>null</c> if not set.
        /// </value>
        public BsonTimestamp SnapshotTime => _snapshotTime;
    }
}