blob: cecd481c05ce518e7285e0b05c837970bb3f0649 (
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
|
/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Essentials.ServiceStack
* File: IManualPlugin.cs
*
* IManualPlugin.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
{
/// <summary>
/// Represents a plugin that may be added to a service stack in user-code
/// instead of the conventional runtime plugin loading system
/// </summary>
public interface IManualPlugin : IDisposable
{
/// <summary>
/// The name of the plugin
/// </summary>
string Name { get; }
/// <summary>
/// Collects all exported services for use within the service stack
/// </summary>
/// <param name="container">The container to add services to</param>
void GetAllExportedServices(IServiceContainer container);
/// <summary>
/// Initializes the plugin, called before accessing any other methods
/// </summary>
void Initialize();
/// <summary>
/// Loads the plugin, called after initialization but before getting
/// endpoints or services to allow for the plugin to configure itself
/// and perform initial setup
/// </summary>
void Load();
/// <summary>
/// Called when an unload was requested, either manually by the plugin controller
/// or when the service stack is unloading
/// </summary>
void Unload();
/// <summary>
/// Passes a console command to the plugin
/// </summary>
/// <param name="command">The raw command text to pass to the plugin from the console</param>
void OnConsoleCommand(string command);
}
}
|
