aboutsummaryrefslogtreecommitdiff
path: root/lib/VNLib.Data.Caching.Extensions/src/ICachePeerAdvertisment.cs
diff options
context:
space:
mode:
Diffstat (limited to 'lib/VNLib.Data.Caching.Extensions/src/ICachePeerAdvertisment.cs')
-rw-r--r--lib/VNLib.Data.Caching.Extensions/src/ICachePeerAdvertisment.cs50
1 files changed, 50 insertions, 0 deletions
diff --git a/lib/VNLib.Data.Caching.Extensions/src/ICachePeerAdvertisment.cs b/lib/VNLib.Data.Caching.Extensions/src/ICachePeerAdvertisment.cs
new file mode 100644
index 0000000..acf883e
--- /dev/null
+++ b/lib/VNLib.Data.Caching.Extensions/src/ICachePeerAdvertisment.cs
@@ -0,0 +1,50 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: VNLib
+* Package: VNLib.Data.Caching.Extensions
+* File: ICachePeerAdvertisment.cs
+*
+* ICachePeerAdvertisment.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;
+
+
+namespace VNLib.Data.Caching.Extensions
+{
+ /// <summary>
+ /// Represents a node that can be advertised to clients
+ /// </summary>
+ public interface ICachePeerAdvertisment
+ {
+ /// <summary>
+ /// The endpoint for clients to connect to to access the cache
+ /// </summary>
+ Uri ConnectEndpoint { get; }
+
+ /// <summary>
+ /// Gets the address for clients to connect to to discover other discovertable nodes
+ /// </summary>
+ Uri? DiscoveryEndpoint { get; }
+
+ /// <summary>
+ /// Gets the unique identifier for this node
+ /// </summary>
+ string NodeId { get; }
+ }
+}