aboutsummaryrefslogtreecommitdiff
path: root/lib/VNLib.Plugins.Extensions.Loading/src/Routing/RoutingExtensions.cs
diff options
context:
space:
mode:
Diffstat (limited to 'lib/VNLib.Plugins.Extensions.Loading/src/Routing/RoutingExtensions.cs')
-rw-r--r--lib/VNLib.Plugins.Extensions.Loading/src/Routing/RoutingExtensions.cs110
1 files changed, 110 insertions, 0 deletions
diff --git a/lib/VNLib.Plugins.Extensions.Loading/src/Routing/RoutingExtensions.cs b/lib/VNLib.Plugins.Extensions.Loading/src/Routing/RoutingExtensions.cs
new file mode 100644
index 0000000..a1817a8
--- /dev/null
+++ b/lib/VNLib.Plugins.Extensions.Loading/src/Routing/RoutingExtensions.cs
@@ -0,0 +1,110 @@
+/*
+* Copyright (c) 2024 Vaughn Nugent
+*
+* Library: VNLib
+* Package: VNLib.Plugins.Extensions.Loading
+* File: RoutingExtensions.cs
+*
+* RoutingExtensions.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger
+* VNLib collection of libraries and utilities.
+*
+* VNLib.Plugins.Extensions.Loading 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 3 of the
+* License, or (at your option) any later version.
+*
+* VNLib.Plugins.Extensions.Loading 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.Reflection;
+using System.Collections.Generic;
+using System.Runtime.CompilerServices;
+
+using VNLib.Plugins.Essentials.Runtime;
+
+namespace VNLib.Plugins.Extensions.Loading.Routing
+{
+
+ /// <summary>
+ /// Provides advanced QOL features to plugin loading
+ /// </summary>
+ public static class RoutingExtensions
+ {
+ private static readonly ConditionalWeakTable<IEndpoint, PluginBase?> _pluginRefs = new();
+ private static readonly ConditionalWeakTable<PluginBase, EndpointCollection> _pluginEndpoints = new();
+
+ /// <summary>
+ /// Constructs and routes the specific endpoint type for the current plugin
+ /// </summary>
+ /// <typeparam name="T">The <see cref="IEndpoint"/> type</typeparam>
+ /// <param name="plugin"></param>
+ /// <exception cref="TargetInvocationException"></exception>
+ public static T Route<T>(this PluginBase plugin) where T : IEndpoint
+ {
+ //Create the endpoint service, then route it
+ T endpoint = plugin.CreateService<T>();
+
+ //Route the endpoint
+ plugin.Route(endpoint);
+
+ //Store ref to plugin for endpoint
+ _pluginRefs.Add(endpoint, plugin);
+
+ return endpoint;
+ }
+
+ /// <summary>
+ /// Routes a single endpoint for the current plugin and exports the collection to the
+ /// service pool
+ /// </summary>
+ /// <param name="plugin"></param>
+ /// <param name="endpoint">The endpoint to add to the collection</param>
+ public static void Route(this PluginBase plugin, IEndpoint endpoint)
+ {
+ /*
+ * Export the new collection to the service pool in the constructor
+ * function to ensure it's only export once per plugin
+ */
+ static EndpointCollection OnCreate(PluginBase plugin)
+ {
+ EndpointCollection collection = new();
+ plugin.ExportService<IVirtualEndpointDefinition>(collection);
+ return collection;
+ }
+
+ //Get the endpoint collection for the current plugin
+ EndpointCollection endpoints = _pluginEndpoints.GetValue(plugin, OnCreate);
+
+ //Add the endpoint to the collection
+ endpoints.Endpoints.Add(endpoint);
+ }
+
+ /// <summary>
+ /// Gets the plugin that loaded the current endpoint
+ /// </summary>
+ /// <param name="ep"></param>
+ /// <returns>The plugin that loaded the current endpoint</returns>
+ /// <exception cref="InvalidOperationException"></exception>
+ public static PluginBase GetPlugin(this IEndpoint ep)
+ {
+ _ = _pluginRefs.TryGetValue(ep, out PluginBase? pBase);
+ return pBase ?? throw new InvalidOperationException("Endpoint was not dynamically routed");
+ }
+
+
+ private sealed class EndpointCollection : IVirtualEndpointDefinition
+ {
+ public List<IEndpoint> Endpoints { get; } = new();
+
+ ///<inheritdoc/>
+ IEnumerable<IEndpoint> IVirtualEndpointDefinition.GetEndpoints() => Endpoints;
+ }
+ }
+}