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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/*
* 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.Text.Json.Serialization;
using VNLib.Data.Caching.Extensions;
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_message_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("retry_interval_sec")]
public int? RetryIntervalSeconds { 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 RetryInterval => TimeSpan.FromSeconds(RetryIntervalSeconds!.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 InitialNode[]? InitialNodes { get; set; }
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 (!RetryIntervalSeconds.HasValue || RetryIntervalSeconds.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");
}
foreach (InitialNode peer in InitialNodes)
{
_ = peer.ConnectEndpoint ?? throw new ArgumentException("You must specify a connect endpoint for each initial node", "initial_nodes");
_ = peer.NodeId ?? throw new ArgumentException("You must specify a node id for each initial node", "initial_nodes");
}
}
public sealed record class InitialNode : ICacheNodeAdvertisment
{
[JsonIgnore]
public Uri ConnectEndpoint { get; private set; }
[JsonIgnore]
public Uri? DiscoveryEndpoint { get; private set; }
[JsonPropertyName("node_id")]
public string? NodeId { get; set; }
[JsonPropertyName("connect_endpoint")]
public string? ConnectEndpointString
{
get => ConnectEndpoint.ToString();
set => ConnectEndpoint = new Uri(value!);
}
[JsonPropertyName("discovery_endpoint")]
public string? DiscoveryEndpointString
{
get => DiscoveryEndpoint?.ToString();
set => DiscoveryEndpoint = value == null ? null : new Uri(value);
}
}
}
}
|
