Libs/VNLib.Plugins.Essentials.Sessions.Runtime/IRuntimeSessionProvider.cs


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

/*
* Copyright (c) 2022 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Essentials.Sessions.Runtime
* File: IRuntimeSessionProvider.cs 
*
* IRuntimeSessionProvider.cs is part of VNLib.Plugins.Essentials.Sessions.Runtime which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Essentials.Sessions.Runtime 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.Essentials.Sessions.Runtime 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.Essentials.Sessions.Runtime. If not, see http://www.gnu.org/licenses/.
*/

using VNLib.Net.Http;
using VNLib.Utils.Logging;

namespace VNLib.Plugins.Essentials.Sessions.Runtime
{
    /// <summary>
    /// Represents a dynamically loadable type that an provide sessions to http connections
    /// </summary>
    public interface IRuntimeSessionProvider : ISessionProvider
    {
        /// <summary>
        /// Called immediatly after the plugin is loaded into the appdomain
        /// </summary>
        /// <param name="plugin">The plugin instance that is loading the module</param>
        /// <param name="localizedLog">The localized log provider for the provider</param>
        void Load(PluginBase plugin, ILogProvider localizedLog);

        /// <summary>
        /// Determines if the provider can return a session for the connection
        /// </summary>
        /// <param name="entity">The entity to process</param>
        /// <returns>A value indicating if this provider should be called to load a session for</returns>
        bool CanProcess(IHttpEvent entity);
    }
}