aboutsummaryrefslogtreecommitdiff
path: root/lib/VNLib.Plugins.Extensions.VNCache/src/VnCacheClientConfig.cs
diff options
context:
space:
mode:
authorLibravatar vnugent <public@vaughnnugent.com>2023-11-02 01:50:05 -0400
committerLibravatar vnugent <public@vaughnnugent.com>2023-11-02 01:50:05 -0400
commitd2d812213b99ee17f9433f81871b694c4053ff23 (patch)
tree11a1106602112c134e65bf197ef701d1b8d63b67 /lib/VNLib.Plugins.Extensions.VNCache/src/VnCacheClientConfig.cs
parent483c014b938e2d55ea7c89b67f6d19ba2c2d5b5e (diff)
also carried away
Diffstat (limited to 'lib/VNLib.Plugins.Extensions.VNCache/src/VnCacheClientConfig.cs')
-rw-r--r--lib/VNLib.Plugins.Extensions.VNCache/src/VnCacheClientConfig.cs139
1 files changed, 0 insertions, 139 deletions
diff --git a/lib/VNLib.Plugins.Extensions.VNCache/src/VnCacheClientConfig.cs b/lib/VNLib.Plugins.Extensions.VNCache/src/VnCacheClientConfig.cs
deleted file mode 100644
index bfa9d92..0000000
--- a/lib/VNLib.Plugins.Extensions.VNCache/src/VnCacheClientConfig.cs
+++ /dev/null
@@ -1,139 +0,0 @@
-/*
-* Copyright (c) 2023 Vaughn Nugent
-*
-* Library: VNLib
-* Package: VNLib.Plugins.Extensions.VNCache
-* File: VnCacheClientConfig.cs
-*
-* VnCacheClientConfig.cs is part of VNLib.Plugins.Extensions.VNCache which is part of the larger
-* VNLib collection of libraries and utilities.
-*
-* VNLib.Plugins.Extensions.VNCache 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.Plugins.Extensions.VNCache 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;
-using System.Linq;
-using System.Text.Json.Serialization;
-
-using VNLib.Plugins.Extensions.Loading;
-
-namespace VNLib.Plugins.Extensions.VNCache
-{
- /// <summary>
- /// Represents a remote VNCache client configuration
- /// </summary>
- public class VnCacheClientConfig : IOnConfigValidation
- {
- /// <summary>
- /// The maximum size (in bytes) of messages sent to the
- /// cache server. This value will be negotiated with the server
- /// during a connection upgrade
- /// </summary>
- [JsonPropertyName("max_object_size")]
- public int? MaxMessageSize { get; set; }
-
- /// <summary>
- /// The broker server address
- /// </summary>
- [JsonPropertyName("use_tls")]
- public bool UseTls { get; set; } = true;
-
- /// <summary>
- /// The time (in seconds) to randomly delay polling the broker server
- /// for available servers
- /// </summary>
- [JsonPropertyName("discovery_interval_Sec")]
- public int? DiscoveryIntervalSeconds { get; set; }
-
- /// <summary>
- /// The maximum time (in seconds) for FBM cache operations are allowed
- /// to take before timing out.
- /// </summary>
- /// <remarks>
- /// NOTE: You should set this value to something reasonable as FBM messages can
- /// be lost and cause deadlocks if your cache implementation does not rely on
- /// CancellationTokens
- /// </remarks>
- [JsonPropertyName("request_timeout_sec")]
- public int? RequestTimeoutSeconds { get; set; }
-
- /// <summary>
- /// Retry interval in a timespan
- /// </summary>
- internal TimeSpan DiscoveryInterval => TimeSpan.FromSeconds(DiscoveryIntervalSeconds!.Value);
-
- /// <summary>
- /// FBM Request timeout
- /// </summary>
- internal TimeSpan RequestTimeout => TimeSpan.FromSeconds(RequestTimeoutSeconds!.Value);
-
- /// <summary>
- /// The initial peers to connect to
- /// </summary>
- [JsonPropertyName("initial_nodes")]
- public string[]? InitialNodes { get; set; }
-
- /// <summary>
- /// Gets the initial nodes as a collection of URIs
- /// </summary>
- /// <returns>The nodes as a collection of URIs</returns>
- /// <exception cref="InvalidOperationException"></exception>
- public Uri[] GetInitialNodeUris()
- {
- _ = InitialNodes ?? throw new InvalidOperationException("Initial nodes have not been set");
- return InitialNodes.Select(static x => new Uri(x, UriKind.Absolute)).ToArray();
- }
-
- void IOnConfigValidation.Validate()
- {
- if (!MaxMessageSize.HasValue || MaxMessageSize.Value < 1)
- {
- throw new ArgumentException("Your maxium message size should be a reasonable value greater than 0", "max_message_size");
- }
-
- if (!DiscoveryIntervalSeconds.HasValue || DiscoveryIntervalSeconds.Value < 1)
- {
- throw new ArgumentException("You must specify a retry interval period greater than 0", "retry_interval_sec");
- }
-
- //Allow a 0 timeout to disable timeouts, not recommended, but allowed
- if(!RequestTimeoutSeconds.HasValue || RequestTimeoutSeconds.Value < 0)
- {
- throw new ArgumentException("You must specify a positive integer FBM message timoeut", "request_timeout_sec");
- }
-
- //Validate initial nodes
- if (InitialNodes == null || InitialNodes.Length == 0)
- {
- throw new ArgumentException("You must specify at least one initial peer", "initial_peers");
- }
-
- //Validate initial nodes
- foreach (Uri peer in GetInitialNodeUris())
- {
- if (!peer.IsAbsoluteUri)
- {
- throw new ArgumentException("You must specify an absolute URI for each initial node", "initial_nodes");
- }
-
- //Verify http connection
- if(peer.Scheme != Uri.UriSchemeHttp && peer.Scheme != Uri.UriSchemeHttps)
- {
- throw new ArgumentException("You must specify an HTTP or HTTPS URI for each initial node", "initial_nodes");
- }
- }
- }
-
- }
-} \ No newline at end of file