/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins
* File: IPlugin.cs
*
* IPlugin.cs is part of VNLib.Plugins which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins 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 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. If not, see http://www.gnu.org/licenses/.
*/
namespace VNLib.Plugins
{
///
/// Allows for applications to define plugin capabilities
///
public interface IPlugin
{
///
/// The name of the plugin to referrence (may be used by the host to interact)
///
string PluginName { get; }
///
/// Performs operations to prepare the plugin for use
///
void Load();
///
/// Invoked when the plugin is unloaded from the runtime
///
void Unload();
///
/// Called directly after the plugin is loaded to allow for service
/// publishing for the host application to use
///
/// NOTE: A service pool is shared for each assembly, if there are multiple
/// plugins per assembly, they will share the same service pool.
///
///
/// The service publisher instance
void PublishServices(IPluginServicePool pool);
}
}