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
|
/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Extensions.VNCache
* File: ScopedCache.cs
*
* ScopedCache.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.Threading;
using System.Threading.Tasks;
using VNLib.Data.Caching;
namespace VNLib.Plugins.Extensions.VNCache.DataModel
{
/// <summary>
/// A cache that stores objects with 1:1 keys unique to this instance. That is, a unique entity
/// that is stored in this cache instance may only be retrieved, deleted, or updated, by the
/// same instance. This is an abstract class.
/// </summary>
public abstract class ScopedCache : IGlobalCacheProvider
{
/// <summary>
/// The <see cref="ICacheKeyGenerator"/> to provide unique
/// cache keys
/// </summary>
protected abstract ICacheKeyGenerator KeyGen { get; }
///<inheritdoc/>
public abstract bool IsConnected { get; }
///<inheritdoc/>
public abstract ICacheObjectDeserializer DefaultDeserializer { get; }
///<inheritdoc/>
public abstract ICacheObjectSerializer DefaultSerializer { get; }
///<inheritdoc/>
public abstract Task<bool> DeleteAsync(string key, CancellationToken cancellation);
///<inheritdoc/>
public abstract Task<T?> GetAsync<T>(string key, ICacheObjectDeserializer deserializer, CancellationToken cancellation);
///<inheritdoc/>
public abstract Task AddOrUpdateAsync<T>(string key, string? newKey, T value, ICacheObjectSerializer serialzer, CancellationToken cancellation);
///<inheritdoc/>
public abstract Task GetAsync<T>(string key, ObjectDataSet<T> callback, T state, CancellationToken cancellation);
///<inheritdoc/>
public abstract Task AddOrUpdateAsync<T>(string key, string? newKey, ObjectDataGet<T> callback, T state, CancellationToken cancellation);
///<inheritdoc/>
public abstract object GetUnderlyingStore();
}
}
|
