blob: 1f4d154ac6dc06a947867602b590520f194cfc95 (
plain)
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
|
/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Data.Caching.Extensions
* File: INodeDiscoveryCollection.cs
*
* INodeDiscoveryCollection.cs is part of VNLib.Data.Caching.Extensions which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Data.Caching.Extensions is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Data.Caching.Extensions is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System.Collections.Generic;
namespace VNLib.Data.Caching.Extensions.Clustering
{
/// <summary>
/// Represents a collection of discovered nodes
/// </summary>
#pragma warning disable CA1711 // Identifiers should not have incorrect suffix
public interface INodeDiscoveryCollection
#pragma warning restore CA1711 // Identifiers should not have incorrect suffix
{
/// <summary>
/// Begins a new discovery and gets an enumerator for the discovery process
/// </summary>
/// <returns>An enumerator that simplifies discovery of unique nodes</returns>
INodeDiscoveryEnumerator BeginDiscovery();
/// <summary>
/// Begins a new discovery and gets an enumerator for the discovery process
/// </summary>
/// <param name="initialPeers">An initial collection of peers to add to the enumeration</param>
/// <returns>An enumerator that simplifies discovery of unique nodes</returns>
INodeDiscoveryEnumerator BeginDiscovery(IEnumerable<CacheNodeAdvertisment> initialPeers);
/// <summary>
/// Gets a snapshot of all discovered nodes in the current collection.
/// </summary>
/// <returns>The current collection of notes</returns>
CacheNodeAdvertisment[] GetAllNodes();
/// <summary>
/// Completes a discovery process and updates the collection with the results
/// </summary>
/// <param name="enumerator">The enumerator used to collect discovered nodes</param>
void CompleteDiscovery(INodeDiscoveryEnumerator enumerator);
}
}
|