blob: 20edf0bf0f3e0dd14e445f9e6707a89deba014e2 (
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
|
/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: ObjectCacheServer
* File: ICacheEventQueueManager.cs
*
* ICacheEventQueueManager.cs is part of ObjectCacheServer which is part of the larger
* VNLib collection of libraries and utilities.
*
* ObjectCacheServer 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.
*
* ObjectCacheServer 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;
namespace VNLib.Data.Caching.ObjectCache.Server
{
/// <summary>
/// Represents a managment system for publishing and subscribing to cache change events
/// </summary>
internal interface ICacheEventQueueManager
{
/// <summary>
/// Publishes a change event to all subscribers
/// </summary>
/// <param name="change">The change event to publish</param>
void PublishSingle(ChangeEvent change);
/// <summary>
/// Publishes multiple change events to all subscribers
/// </summary>
/// <param name="changes">The span of changes to publish to all subscribers</param>
void PublishMultiple(Span<ChangeEvent> changes);
/// <summary>
/// Attatches a subscriber that will receive all published changes
/// </summary>
/// <param name="peer">The peer node that wishes to subscribe for events</param>
/// <returns>The initilaizes event queue for the single subscriber</returns>
IPeerEventQueue Subscribe(ICachePeer peer);
/// <summary>
/// Detatches a subscriber from the event queue
/// </summary>
/// <param name="peer">The peer to unsubscribe from events</param>
void Unsubscribe(ICachePeer peer);
/// <summary>
/// Purges all stale subcriber nodes
/// </summary>
void PurgeStaleSubscribers();
}
}
|
