/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Data.Caching.Providers.VNCache
* File: VnCacheClientConfig.cs
*
* VnCacheClientConfig.cs is part of VNLib.Data.Caching.Providers.VNCache which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Data.Caching.Providers.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.Data.Caching.Providers.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;
namespace VNLib.Data.Caching.Providers.VNCache
{
///
/// Represents a remote VNCache client configuration
///
public class VnCacheClientConfig : VNCacheConfig
{
const string DefaultWellKnownEndpoint = "/.well-known/vncache";
///
/// The broker server address
///
[JsonPropertyName("use_tls")]
public bool UseTls { get; set; } = true;
///
/// The time (in seconds) to randomly delay polling the broker server
/// for available servers
///
[JsonPropertyName("discovery_interval_sec")]
public int? DiscoveryIntervalSeconds { get; set; }
///
/// The maximum time (in seconds) for FBM cache operations are allowed
/// to take before timing out.
///
///
/// 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
///
[JsonPropertyName("request_timeout_sec")]
public int? RequestTimeoutSeconds { get; set; }
///
/// Retry interval in a timespan
///
internal TimeSpan DiscoveryInterval => TimeSpan.FromSeconds(DiscoveryIntervalSeconds!.Value);
///
/// FBM Request timeout
///
internal TimeSpan RequestTimeout => TimeSpan.FromSeconds(RequestTimeoutSeconds!.Value);
///
/// The time in milliseconds for the initial node delay
///
[JsonPropertyName("intial_delay_ms")]
public uint? InitialNodeDelay { get; set; }
///
/// The initial peers to connect to
///
[JsonPropertyName("initial_nodes")]
public string[]? InitialNodes { get; set; }
///
/// Gets the initial nodes as a collection of URIs
///
/// The nodes as a collection of URIs
///
public Uri[] GetInitialNodeUris()
{
_ = InitialNodes ?? throw new InvalidOperationException("Initial nodes have not been set");
return InitialNodes.Select(static x =>
{
//Append a default well known endpoint if the path is just a root
Uri ur = new (x, UriKind.Absolute);
return ur.LocalPath == "/" ? new Uri(ur, DefaultWellKnownEndpoint) : ur;
})
.ToArray();
}
///
public override void Validate()
{
base.Validate();
if (!DiscoveryIntervalSeconds.HasValue || DiscoveryIntervalSeconds.Value < 1)
{
throw new ArgumentException("You must specify a discovery 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");
}
}
}
}
}