lib/VNLib.Data.Caching.ObjectCache/src/ChangeEvent.cs


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

/*
* Copyright (c) 2022 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Data.Caching.ObjectCache
* File: ChangeEvent.cs 
*
* ChangeEvent.cs is part of VNLib.Data.Caching.ObjectCache which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Data.Caching.ObjectCache 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.ObjectCache 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/.
*/

namespace VNLib.Data.Caching.ObjectCache
{
    /// <summary>
    /// An event object that is passed when change events occur
    /// </summary>
    public sealed class ChangeEvent
    {
        /// <summary>
        /// The current id of the changed object
        /// </summary>
        public string CurrentId { get; }

        /// <summary>
        /// The alternate id of the changed object if specified
        /// </summary>
        public string? AlternateId { get; }
        
        /// <summary>
        /// A value that indicates if the object was deleted 
        /// </summary>
        public bool Deleted { get; }
        
        internal ChangeEvent(string id, string? alternate, bool deleted)
        {
            CurrentId = id;
            AlternateId = alternate;
            Deleted = deleted;
        }
    }
}