aboutsummaryrefslogtreecommitdiff
path: root/plugins/VNLib.Data.Caching.Providers.VNCache/src/MemoryCacheConfig.cs
blob: 177ba04c4daade3220dc0a796bf4ac6f3406c12d (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
/*
* Copyright (c) 2024 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.Configuration;

namespace VNLib.Data.Caching.Providers.VNCache
{
    /// <summary>
    /// Memorycache configuration object
    /// </summary>
    public sealed class MemoryCacheConfig : VNCacheConfig
    {
        /// <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;

        ///<inheritdoc/>
        public override void OnValidate()
        {
            base.OnValidate();

            Validate.Assert(TableSize > 0, "You must specify a number of cache buckets");
            Validate.Assert(BucketSize > 0, "You must specify a 'bucket_size'");
        }
    }
}