aboutsummaryrefslogtreecommitdiff
path: root/Plugins/src/Attributes/LogInitializerAttribute.cs
blob: 61264fbf8292c90ffccf262ce4a297b4729dc52d (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
/*
* Copyright (c) 2022 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins
* File: LogInitializerAttribute.cs 
*
* LogInitializerAttribute.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/.
*/

using System;

namespace VNLib.Plugins.Attributes
{
    /// <summary>
    /// Set this attribute on an <see cref="IPlugin"/> instance method to define the log initalizer.
    /// This attribute can only be defined on a single instance method and cannot be overloaded.
    /// <br></br>
    /// A plugin host should invoke this method before <see cref="IPlugin.Load"/> but after a <see cref="ConfigurationInitalizerAttribute"/> method
    /// <br></br>
    /// Method signature <code>public void [methodname] (<see cref="string"/>[] cmdArgs)</code> 
    /// </summary>
    [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
    public sealed class LogInitializerAttribute : Attribute
    { }

    /// <summary>
    /// Represents a safe logger initializer delegate method
    /// </summary>
    /// <param name="args">The arguments to pass to the log iniializer (usually command line args)</param>
    public delegate void LogInitializer(string[] args);
}