-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
ICluster.cs
108 lines (97 loc) · 3.44 KB
/
ICluster.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
97
98
99
100
101
102
103
104
105
106
107
108
/* Copyright 2013-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 System.Threading;
using System.Threading.Tasks;
using MongoDB.Driver.Core.Bindings;
using MongoDB.Driver.Core.Clusters.ServerSelectors;
using MongoDB.Driver.Core.Configuration;
using MongoDB.Driver.Core.Servers;
using MongoDB.Libmongocrypt;
namespace MongoDB.Driver.Core.Clusters
{
/// <summary>
/// Represents a MongoDB cluster.
/// </summary>
public interface ICluster : IDisposable
{
// events
/// <summary>
/// Occurs when the cluster description has changed.
/// </summary>
event EventHandler<ClusterDescriptionChangedEventArgs> DescriptionChanged;
// properties
/// <summary>
/// Gets the cluster identifier.
/// </summary>
/// <value>
/// The cluster identifier.
/// </value>
ClusterId ClusterId { get; }
/// <summary>
/// Gets the cluster description.
/// </summary>
/// <value>
/// The cluster description.
/// </value>
ClusterDescription Description { get; }
/// <summary>
/// Gets the cluster settings.
/// </summary>
/// <value>
/// The cluster settings.
/// </value>
ClusterSettings Settings { get; }
// methods
/// <summary>
/// Acquires a core server session.
/// </summary>
/// <returns>A core server session.</returns>
ICoreServerSession AcquireServerSession();
/// <summary>
/// Gets the crypt client.
/// </summary>
/// <returns>A crypt client.</returns>
#pragma warning disable CS3003
CryptClient CryptClient { get; }
#pragma warning restore
/// <summary>
/// Initializes the cluster.
/// </summary>
void Initialize();
/// <summary>
/// Selects a server from the cluster.
/// </summary>
/// <param name="selector">The server selector.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The selected server.</returns>
IServer SelectServer(IServerSelector selector, CancellationToken cancellationToken);
/// <summary>
/// Selects a server from the cluster.
/// </summary>
/// <param name="selector">The server selector.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>A Task representing the operation. The result of the Task is the selected server.</returns>
Task<IServer> SelectServerAsync(IServerSelector selector, CancellationToken cancellationToken);
/// <summary>
/// Starts a session.
/// </summary>
/// <param name="options">The options.</param>
/// <returns>
/// A session.
/// </returns>
ICoreSessionHandle StartSession(CoreSessionOptions options = null);
}
}