forked from mongodb/mongo-csharp-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ReadPreferenceHedge.cs
96 lines (84 loc) · 2.86 KB
/
ReadPreferenceHedge.cs
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
/* Copyright 2020-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 System;
using MongoDB.Bson;
namespace MongoDB.Driver
{
/// <summary>
/// Represents a read preference hedge.
/// </summary>
public sealed class ReadPreferenceHedge : IEquatable<ReadPreferenceHedge>
{
#region static
// private static fields
private static readonly ReadPreferenceHedge __disabled = new ReadPreferenceHedge(isEnabled: false);
private static readonly ReadPreferenceHedge __enabled = new ReadPreferenceHedge(isEnabled: true);
// public static properties
/// <summary>
/// Gets a disabled read preference hedge.
/// </summary>
public static ReadPreferenceHedge Disabled => __disabled;
/// <summary>
/// Gets an enabled read preference hedge.
/// </summary>
public static ReadPreferenceHedge Enabled => __enabled;
#endregion
// private fields
private readonly bool _isEnabled;
// constructors
/// <summary>
/// Initializes an instance of ReadPreferenceHedge.
/// </summary>
/// <param name="isEnabled">Whether hedged reads are enabled.</param>
public ReadPreferenceHedge(bool isEnabled)
{
_isEnabled = isEnabled;
}
// public properties
/// <summary>
/// Gets whether hedged reads are enabled.
/// </summary>
public bool IsEnabled => _isEnabled;
// public methods
/// <inheritdoc/>
public override bool Equals(object obj)
{
return Equals(obj as ReadPreferenceHedge);
}
/// <inheritdoc/>
public bool Equals(ReadPreferenceHedge other)
{
return other != null && _isEnabled == other._isEnabled;
}
/// <inheritdoc/>
public override int GetHashCode()
{
return _isEnabled.GetHashCode();
}
/// <summary>
/// Converts the read preference hedge to a BsonDocument.
/// </summary>
/// <returns>A BsonDocument.</returns>
public BsonDocument ToBsonDocument()
{
return new BsonDocument("enabled", _isEnabled);
}
/// <inheritdoc/>
public override string ToString()
{
return ToBsonDocument().ToJson();
}
}
}