diff options
Diffstat (limited to 'lib/VNLib.Plugins.Extensions.Loading/src/IAsyncBackgroundWork.cs')
-rw-r--r-- | lib/VNLib.Plugins.Extensions.Loading/src/IAsyncBackgroundWork.cs | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/lib/VNLib.Plugins.Extensions.Loading/src/IAsyncBackgroundWork.cs b/lib/VNLib.Plugins.Extensions.Loading/src/IAsyncBackgroundWork.cs new file mode 100644 index 0000000..9fb66a2 --- /dev/null +++ b/lib/VNLib.Plugins.Extensions.Loading/src/IAsyncBackgroundWork.cs @@ -0,0 +1,46 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins.Extensions.Loading +* File: LoadingExtensions.cs +* +* LoadingExtensions.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins.Extensions.Loading 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.Loading 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.Tasks; +using VNLib.Utils.Logging; +using System.Threading; + +namespace VNLib.Plugins.Extensions.Loading +{ + /// <summary> + /// Represents a low priority or long running work task to be done + /// and observed by a loaded plugin + /// </summary> + public interface IAsyncBackgroundWork + { + /// <summary> + /// Called when low priority work is ready to be run and its results + /// marshaled back to the plugin context + /// </summary> + /// <param name="pluginLog">The plugins default log provider</param> + /// <param name="exitToken">A token that signals when the plugin is unloading and work should be cancelled</param> + /// <returns>A task representing the low priority work to observed</returns> + Task DoWorkAsync(ILogProvider pluginLog, CancellationToken exitToken); + } +} |