diff options
Diffstat (limited to 'lib/Plugins.PluginBase')
| -rw-r--r-- | lib/Plugins.PluginBase/src/IPluginTaskObserver.cs | 46 | ||||
| -rw-r--r-- | lib/Plugins.PluginBase/src/PluginBase.cs | 17 |
2 files changed, 52 insertions, 11 deletions
diff --git a/lib/Plugins.PluginBase/src/IPluginTaskObserver.cs b/lib/Plugins.PluginBase/src/IPluginTaskObserver.cs new file mode 100644 index 0000000..df75614 --- /dev/null +++ b/lib/Plugins.PluginBase/src/IPluginTaskObserver.cs @@ -0,0 +1,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); + } +}
\ No newline at end of file diff --git a/lib/Plugins.PluginBase/src/PluginBase.cs b/lib/Plugins.PluginBase/src/PluginBase.cs index 37dafc6..d2564a6 100644 --- a/lib/Plugins.PluginBase/src/PluginBase.cs +++ b/lib/Plugins.PluginBase/src/PluginBase.cs @@ -38,11 +38,12 @@ using VNLib.Plugins.Attributes; namespace VNLib.Plugins { + /// <summary> /// Provides a concrete base class for <see cref="IPlugin"/> instances using the Serilog logging provider. /// Accepts the standard plugin <see cref="JsonDocument"/> configuration constructors /// </summary> - public abstract class PluginBase : MarshalByRefObject, IPlugin + public abstract class PluginBase : MarshalByRefObject, IPlugin, IPluginTaskObserver { /* * CTS exists for the life of the plugin, its resources are never disposed @@ -90,9 +91,7 @@ namespace VNLib.Plugins /// </summary> public JsonElement PluginConfig => Configuration.RootElement.GetProperty(GetType().Name); - /// <summary> /// <inheritdoc/> - /// </summary> public abstract string PluginName { get; } /// <summary> @@ -340,10 +339,7 @@ namespace VNLib.Plugins } } - /// <summary> - /// Adds a task to the observation list - /// </summary> - /// <param name="task">The task to observe</param> + ///<inheritdoc/> public void ObserveTask(Task task) { lock (DeferredTasks) @@ -352,10 +348,7 @@ namespace VNLib.Plugins } } - /// <summary> - /// Removes a task from the task observation list - /// </summary> - /// <param name="task">The task to remove</param> + ///<inheritdoc/> public void RemoveObservedTask(Task task) { lock (DeferredTasks) @@ -379,10 +372,12 @@ namespace VNLib.Plugins /// </para> /// </summary> protected abstract void OnLoad(); + /// <summary> /// Invoked when all endpoints have been removed from service. All managed and unmanged resources should be released. /// </summary> protected abstract void OnUnLoad(); + /// <summary> /// Invoked before <see cref="IPlugin.GetEndpoints"/> called by the host app to get all endpoints /// for the current plugin |