/*
* Copyright (c) 2022 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Essentials.ServiceStack
* File: IPluginController.cs
*
* IPluginController.cs is part of VNLib.Plugins.Essentials.ServiceStack which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Essentials.ServiceStack 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 2 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Essentials.ServiceStack 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.Text.Json;
using VNLib.Utils.Logging;
namespace VNLib.Plugins.Essentials.ServiceStack
{
///
/// Represents a live plugin controller that manages all
/// plugins loaded in a
///
public interface IPluginController
{
///
/// Loads all plugins specified by the host config to the service manager,
/// or attempts to load plugins by the default
///
/// The configuration instance to pass to plugins
/// A log provider to write message and errors to
/// A task that resolves when all plugins are loaded
Task LoadPlugins(JsonDocument config, ILogProvider appLog);
///
/// Sends a message to a plugin identified by it's name.
///
/// The name of the plugin to pass the message to
/// The message to pass to the plugin
/// The name string comparison type
/// True if the plugin was found and it has a message handler loaded
///
bool SendCommandToPlugin(string pluginName, string message, StringComparison nameComparison = StringComparison.Ordinal);
///
/// Manually reloads all plugins loaded to the current service manager
///
///
///
void ForceReloadAllPlugins();
///
/// Unloads all service groups, removes them, and unloads all
/// loaded plugins
///
///
///
void UnloadAll();
}
}