blob: fdf1c5e960f8831460192c603d136d4a9522c0f2 (
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
|
/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Data.Caching.Providers.VNCache
* File: RemoteCacheOperator.cs
*
* RemoteCacheOperator.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.Threading;
using System.Threading.Tasks;
using VNLib.Utils.Logging;
using VNLib.Plugins;
using VNLib.Plugins.Extensions.Loading;
namespace VNLib.Data.Caching.Providers.VNCache
{
/// <summary>
/// Represents a handle to a VNCache cache client, that exposes a cancellable
/// <see cref="IAsyncBackgroundWork"/> to run inside a <see cref="PluginBase"/>
/// or standlone in your own background work handler
/// </summary>
/// <remarks>
/// The background work method must be sheduled for the cache client to be
/// connected to the backing store
/// </remarks>
public sealed class RemoteCacheOperator : IAsyncBackgroundWork
{
private readonly FBMCacheClient _client;
private CancellationTokenSource? _tokenSource;
internal RemoteCacheOperator(FBMCacheClient client, RemoteBackedMemoryCache? memCache)
{
//Store the client to be used in the background work
_client = client;
Cache = memCache ?? (IGlobalCacheProvider)client; //Cache is the remote backing store
}
/// <summary>
/// The configured global cache instance
/// </summary>
public IGlobalCacheProvider Cache { get; }
///<inheritdoc/>
///<exception cref="ArgumentNullException"></exception>
public async Task DoWorkAsync(ILogProvider pluginLog, CancellationToken exitToken)
{
_ = pluginLog ?? throw new ArgumentNullException(nameof(pluginLog));
//Create cts linked to the exit token to allow user cancellation of the listener
using (_tokenSource = CancellationTokenSource.CreateLinkedTokenSource(exitToken))
{
//Do work with linked source
await _client.DoWorkAsync(pluginLog, _tokenSource.Token)
.ConfigureAwait(false);
}
//Remove cts
_tokenSource = null;
}
/// <summary>
/// Cancels the background cache client listener
/// </summary>
public void CancelListener() => _tokenSource?.Cancel();
}
}
|
