/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Essentials.ServiceStack
* File: IManagedPlugin.cs
*
* IManagedPlugin.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;
using System.ComponentModel.Design;
namespace VNLib.Plugins.Essentials.ServiceStack
{
///
/// Represents a plugin managed by a that includes dynamically loaded plugins
///
public interface IManagedPlugin
{
///
/// The exposed services the inernal plugin provides
///
///
/// WARNING: Services exposed by the plugin will abide by the plugin lifecycle, so consumers
/// must listen for plugin load/unload events to respect lifecycles properly.
///
IServiceContainer Services { get; }
///
/// Internal call to get all exported plugin endpoints
///
///
internal IEndpoint[] GetEndpoints();
///
/// Internal notification that the plugin is loaded
///
internal void OnPluginLoaded();
///
/// Internal notification that the plugin is unloaded
///
internal void OnPluginUnloaded();
///
/// Sends the specified command to the desired plugin by it's name
///
/// The name of the plugin to find
/// The command text to send to the plugin
/// The string name comparison type
/// True if the command was sent successfully
internal bool SendCommandToPlugin(string pluginName, string command, StringComparison comp);
}
}