aboutsummaryrefslogtreecommitdiff
path: root/lib/VNLib.Plugins.Extensions.VNCache/src/DataModel/EntityCacheBuilder.cs
blob: ea1566df98d96113af7dc182e89d386dc7d89d2f (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
/*
* Copyright (c) 2024 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Extensions.VNCache
* File: EntityCacheBuilder.cs 
*
* EntityCacheBuilder.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.Threading.Tasks;

using VNLib.Utils.Logging;

namespace VNLib.Plugins.Extensions.VNCache.DataModel
{
    /// <summary>
    /// Represents a cache that can store entities by their unique key
    /// </summary>
    /// <typeparam name="TEntity"></typeparam>
    /// <param name="cache"></param>
    public sealed class EntityCacheBuilder<TEntity>(IEntityCache<TEntity> cache)
        where TEntity : class
    {
        ICacheExpirationPolicy<TEntity>? _expPolicy;
        ICacheTaskPolicy? _taskPolicy;

        public EntityCacheBuilder<TEntity> WithExpirationPoicy(ICacheExpirationPolicy<TEntity> expiration)
        {
            _expPolicy = expiration;
            return this;
        }

        public EntityCacheBuilder<TEntity> WithInfiniteExpiration()
        {
            _expPolicy = new InfiniteCacheExpirationPolicy<TEntity>();
            return this;
        }

        public EntityCacheBuilder<TEntity> WithTaskPolicy(ICacheTaskPolicy taskPolicy)
        {
            _taskPolicy = taskPolicy;
            return this;
        }

        public EntityCacheBuilder<TEntity> WithWriteBackPolicy(Action<Task> onFaulted)
        {
            _taskPolicy = new WriteBackCachePolicy(onFaulted);
            return this;
        }

        public EntityCacheBuilder<TEntity> WithWriteBackPolicy(ILogProvider logger, LogLevel logLevel = LogLevel.Warning)
        {
            _taskPolicy = new WriteBackCachePolicy((t) =>
            {
                logger.Write(logLevel, t.Exception!, "Background task operation failed with exception: ");
            });

            return this;
        }

        public EntityCacheBuilder<TEntity> WithWriteThoughPolicy()
        {
            _taskPolicy = WriteThroughCachePolicy.Instance;
            return this;
        }
      

        public EntityResultCache<TEntity> Build()
        {
            ArgumentNullException.ThrowIfNull(_expPolicy, "Expiration");
            ArgumentNullException.ThrowIfNull(cache);
            ArgumentNullException.ThrowIfNull(_taskPolicy, "TaskPolicy");

            return new EntityResultCache<TEntity>(cache, _taskPolicy, _expPolicy);
        }
    }
   
}