From 3fb601d14354c867e1ead94b027c99c4a2fc15b5 Mon Sep 17 00:00:00 2001 From: vman Date: Wed, 16 Nov 2022 14:07:28 -0500 Subject: Add project files. --- .../VNLib.Plugins.Extensions.Loading.xml | 257 +++++++++++++++++++++ 1 file changed, 257 insertions(+) create mode 100644 VNLib.Plugins.Extensions.Loading/VNLib.Plugins.Extensions.Loading.xml (limited to 'VNLib.Plugins.Extensions.Loading/VNLib.Plugins.Extensions.Loading.xml') diff --git a/VNLib.Plugins.Extensions.Loading/VNLib.Plugins.Extensions.Loading.xml b/VNLib.Plugins.Extensions.Loading/VNLib.Plugins.Extensions.Loading.xml new file mode 100644 index 0000000..86bb96d --- /dev/null +++ b/VNLib.Plugins.Extensions.Loading/VNLib.Plugins.Extensions.Loading.xml @@ -0,0 +1,257 @@ + + + + VNLib.Plugins.Extensions.Loading + + + + + Specifies a configuration variable name in the plugin's configuration + containing data specific to the type + + + + + + + + + + Initializes a new + + The name of the configuration variable for the class + + + + Contains extensions for plugin configuration specifc extensions + + + + + Retrieves a top level configuration dictionary of elements for the specified type. + The type must contain a + + The type to get the configuration of + + A of top level configuration elements for the type + + + + + Retrieves a top level configuration dictionary of elements with the specified property name, + from the plugin config first, or falls back to the host config file + + + The config property name to retrieve + A of top level configuration elements for the type + + + + + Retrieves a top level configuration dictionary of elements with the specified property name, + from the plugin config first, or falls back to the host config file + + + The config property name to retrieve + A of top level configuration elements for the type + + + + + Retrieves a top level configuration dictionary of elements for the specified type. + The type must contain a + + + The type to get configuration data for + A of top level configuration elements for the type + + + + + Shortcut extension for to get + config of current class + + The object that a configuration can be retrieved for + The plugin containing configuration variables + A of top level configuration elements for the type + + + + + Determines if the current plugin configuration contains the require properties to initialize + the type + + + + True if the plugin config contains the require configuration property + + + + When added to a method schedules it as a callback on a specified interval when + the plugin is loaded, and stops when unloaded + + + + + Intializes the with the specified timeout in milliseconds + + The interval in milliseconds + + + + The configurable event interval resulution type + + + + + Specifies event interval resolution in milliseconds + + + + + Specifies event interval resolution in seconds + + + + + Specifies event interval resolution in minutes + + + + + Specifies event interval resolution in hours + + + + + When added to a method schedules it as a callback on a specified interval when + the plugin is loaded, and stops when unloaded + + + + + Initializes a with the specified + interval property name + + The configuration property name for the event interval + The time resoltion for the event interval + + + + Represents a handle to a scheduled event interval that is managed by the plugin but may be cancled by disposing the instance + + + + + Pauses the event timer until the is released or disposed + then resumes to the inital interval period + + A that restores the timer to its initial state when disposed + + + + + + + + Provides event schedueling extensions for plugins + + + + + Schedules an asynchronous event interval for the current plugin, that is active until canceled or until the plugin unloads + + Stateful event argument + + An asyncrhonous callback method. + + The event interval + An that can manage the interval state + + If exceptions are raised during callback execution, they are written to the plugin's default log provider + + + + Provides common loading (and unloading when required) extensions for plugins + + + + + Gets the plugins ambient if loaded, or loads it if required. This class will + be unloaded when the plugin us unloaded. + + + The ambient + + + + + + + Gets or loads the plugin's ambient , with the specified user-table name, + or the default table name + + + The ambient for the current plugin + + + + + + Determintes if the current plugin config has a debug propety set + + + True if debug mode is enabled, false otherwise + + + + + Internal exception helper to raise if the plugin has been unlaoded + + + + + + + Constructs and routes the specific endpoint type for the current plugin + + The type + + The path to the plugin sepcific configuration property + + + + + Constructs and routes the specific endpoint type for the current plugin + + The type + + + + + + Provides common basic SQL loading extensions for plugins + + + + + Gets (or loads) the ambient sql connection factory for the current plugin + + + The ambient factory + + + + + + Gets (or loads) the ambient configured from + the ambient sql factory + + + The ambient for the current plugin + + + If plugin is in debug mode, writes log data to the default log + + + -- cgit