blob: 176333fa0c7b4cfe7c27ca7bafad09737240fdcd (
plain)
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
|
/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Data.Caching.Providers.VNCache
* File: MemoryCacheConfig.cs
*
* MemoryCacheConfig.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.Text.Json.Serialization;
using VNLib.Plugins.Extensions.Loading;
namespace VNLib.Data.Caching.Providers.VNCache
{
/// <summary>
/// Memorycache configuration object. Json-(de)serializable
/// </summary>
public sealed class MemoryCacheConfig : ICacheRefreshPolicy, IOnConfigValidation
{
/// <summary>
/// The number of buckets within the cache table
/// </summary>
[JsonPropertyName("buckets")]
public uint TableSize { get; set; } = 10;
/// <summary>
/// The number of cache entries within each bucket
/// </summary>
[JsonPropertyName("bucket_size")]
public uint BucketSize { get; set; } = 5000;
/// <summary>
/// The maxium size (in bytes) of each cache entry within any bucket
/// </summary>
[JsonPropertyName("max_object_size")]
public uint MaxBlobSize { get; set; } = 16 * 1024;
[JsonIgnore]
public TimeSpan MaxCacheAge { get; set; } = TimeSpan.FromMinutes(1);
/// <summary>
/// When refresh intervals are configured, The maxium cache entry age in seconds.
/// </summary>
[JsonPropertyName("max_age_sec")]
public uint MaxAgeSeconds
{
get => (uint)MaxCacheAge.TotalSeconds;
set => MaxCacheAge = TimeSpan.FromSeconds(value);
}
/*
* Default disable cache
*/
[JsonIgnore]
public TimeSpan RefreshInterval { get; set; } = TimeSpan.Zero;
/// <summary>
/// The time (in seconds) a cache entry refresh interval will occur
/// if scheduled on a plugin
/// </summary>
[JsonPropertyName("refresh_interval_sec")]
public uint RefreshIntervalSeconds
{
get => (uint)RefreshInterval.TotalSeconds;
set => RefreshInterval = TimeSpan.FromSeconds(value);
}
/// <summary>
/// Zeros all cache entry memory allocations before they are used
/// </summary>
[JsonPropertyName("zero_all")]
public bool ZeroAllAllocations { get; set; }
///<inheritdoc/>
public void Validate()
{
if (TableSize == 0)
{
throw new ArgumentException("You must specify a cache bucket table size", "buckets");
}
if (BucketSize == 0)
{
throw new ArgumentException("You must specify the maxium number of entires allowed in each bucket ", "bucket_size");
}
if (MaxBlobSize < 16)
{
throw new ArgumentException("You must configure a maximum object size", "max_object_size");
}
}
}
}
|
