aboutsummaryrefslogtreecommitdiff
path: root/lib/Plugins.PluginBase/src/IPluginTaskObserver.cs
blob: df7561460ae5808ea5f70731d8e658de7f8a6d9f (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
/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.PluginBase
* File: IPluginTaskObserver.cs 
*
* IPluginTaskObserver.cs is part of VNLib.Plugins.PluginBase which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.PluginBase is free software: you can redistribute it and/or modify 
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
* VNLib.Plugins.PluginBase 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 
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License 
* along with VNLib.Plugins.PluginBase. If not, see http://www.gnu.org/licenses/.
*/

using System.Threading.Tasks;

namespace VNLib.Plugins
{
    /// <summary>
    /// Represents an plugin task observer to observe background operations
    /// </summary>
    public interface IPluginTaskObserver
    {
        /// <summary>
        /// Adds a task to the observation list
        /// </summary>
        /// <param name="task">The task to observe</param>
        void ObserveTask(Task task);

        /// <summary>
        /// Removes a task from the task observation list
        /// </summary>
        /// <param name="task">The task to remove</param>
        void RemoveObservedTask(Task task);
    }
}