1 files changed, 58 insertions, 0 deletions
diff --git a/plugins/ObjectCacheServer/src/Distribution/INodeDiscoveryCollection.cs b/plugins/ObjectCacheServer/src/Distribution/INodeDiscoveryCollection.cs
new file mode 100644
index 0000000..d69da40
--- /dev/null
+++ b/plugins/ObjectCacheServer/src/Distribution/INodeDiscoveryCollection.cs
@@ -0,0 +1,58 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+* 
+* Library: VNLib
+* Package: ObjectCacheServer
+* File: INodeDiscoveryCollection.cs 
+*
+* INodeDiscoveryCollection.cs is part of ObjectCacheServer which is 
+* part of the larger VNLib collection of libraries and utilities.
+*
+* ObjectCacheServer 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.
+*
+* ObjectCacheServer 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;
+
+using VNLib.Data.Caching.Extensions;
+
+namespace VNLib.Data.Caching.ObjectCache.Server.Distribution
+{
+    internal interface INodeDiscoveryCollection
+    {
+        /// <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<ICachePeerAdvertisment> initialPeers);
+
+        /// <summary>
+        /// Gets a snapshot of all discovered nodes in the current collection.
+        /// </summary>
+        /// <returns>The current collection of notes</returns>
+        ICachePeerAdvertisment[] 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);
+    }
+}