blob: 3394208df3ed3362762d64c08c489d38f238ca67 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Essentials.ServiceStack
* File: IPluginManager.cs
*
* IPluginManager.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.Collections.Generic;
using VNLib.Utils.Logging;
namespace VNLib.Plugins.Essentials.ServiceStack
{
/// <summary>
/// Represents a live plugin controller that manages all
/// plugins loaded in a <see cref="ServiceDomain"/>
/// </summary>
public interface IPluginManager
{
/// <summary>
/// The the plugins managed by this <see cref="IPluginManager"/>
/// </summary>
public IEnumerable<IManagedPlugin> Plugins { get; }
/// <summary>
/// Loads all plugins specified by the host config to the service manager,
/// or attempts to load plugins by the default
/// </summary>
/// <param name="config">The plugin loading configuration</param>
/// <param name="appLog">A log provider to write message and errors to</param>
/// <returns>A task that resolves when all plugins are loaded</returns>
void LoadPlugins(IPluginLoadConfiguration config, ILogProvider appLog);
/// <summary>
/// Sends a message to a plugin identified by it's name.
/// </summary>
/// <param name="pluginName">The name of the plugin to pass the message to</param>
/// <param name="message">The message to pass to the plugin</param>
/// <param name="nameComparison">The name string comparison type</param>
/// <returns>True if the plugin was found and it has a message handler loaded</returns>
/// <exception cref="ObjectDisposedException"></exception>
bool SendCommandToPlugin(string pluginName, string message, StringComparison nameComparison = StringComparison.Ordinal);
/// <summary>
/// Manually reloads all plugins loaded to the current service manager
/// </summary>
/// <exception cref="AggregateException"></exception>
/// <exception cref="ObjectDisposedException"></exception>
void ForceReloadAllPlugins();
/// <summary>
/// Unloads all loaded plugins and calls thier event handlers
/// </summary>
void UnloadPlugins();
}
}
|
