Plugin - класс

Плагин.

Definition

Пространство имён: Chronos.Plugins
Сборка: Chronos.Plugins (в Chronos.Plugins.dll) Версия: 4.0.4
C#
public abstract class Plugin : IPlugin
Inheritance
Object    Plugin
Derived
Implements
IPlugin

Заметки

Вежливая остановка может происходить при остановке хоста, запущенного как сервис Windows, или при вводе команды остановки в хосте, запущенном в консоли (при закрытии окна консоли или при завершении процесса хоста через диспетчер вежливой остановки не производится). При этом все запущенные плагины имеют некоторое время, определяемое настройками хоста (порядка 30 секунд), для того, чтобы корректно завершить свою работу. Если метод StopAsync(IPluginStopToken) не успел выполнить все действия за заданное время, то процесс плагина будет принудительно остановлен.

Конструкторы

PluginИнициализирует новый экземпляр класса Plugin

Свойства

CidName Уникальное имя компонента для Discovery.
StopRequested

Признак того, что запрошена остановка плагина. Значение свойства можно изменить только на true.

Свойство устанавливается равным true сразу при запрошенной остановке плагина, тогда как CancellationToken, переданный в метод EntryPointAsync(CancellationToken), отменяется за несколько секунд до таймаута плагина, в соответсвии с настройкой AwaitCancellationDeltaSeconds в файле app.json.

StopRequestedToken Токен отмены плагина, который запрашивается сразу при установке свойства StopRequested равным true, т.е. в момент запроса остановки плагина. Объект CancellationToken, переданный в метод EntryPointAsync(CancellationToken), отменяется за несколько секунд до таймаута плагина, в соответсвии с настройкой AwaitCancellationDeltaSeconds в файле app.json.

Методы

EntryPointAsync Асинхронный метод, вызываемый хостом при запуске плагина.
EqualsDetermines whether the specified object is equal to the current object.
(Унаследован от Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Унаследован от Object)
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
StopAsync Метод, вызываемый хостом при вежливой остановке плагина. Он должен максимально быстро завершить выполнение плагина, но не завершать свою работу до тех пор, пока потоки, с которыми работает плагин, не будут завершены.
ToStringReturns a string that represents the current object.
(Унаследован от Object)

Методы расширения

Get
(Определяется ComHelper)
Invoke
(Определяется ComHelper)
LoadConfigAsync Загружает первый используемый конфигурационный файл для заданного плагина, и возвращает загруженный XML-документ.
(Определяется PluginExtensions)
LoadConfigAsync Загружает конфигурационный файл для заданного плагина и указанного пути к файлу относительно папки, в которой расположена сборка с плагином, и возвращает загруженный XML-документ.
(Определяется PluginExtensions)
Set
(Определяется ComHelper)
TryLoadConfigAsync Загружает первый используемый конфигурационный файл для заданного плагина, и возвращает загруженный XML-документ или null, если файл отсутствовал по заданному пути.
(Определяется PluginExtensions)
TryLoadConfigAsync Загружает конфигурационный файл для заданного плагина и указанного пути к файлу относительно папки, в которой расположена сборка с плагином, и возвращает загруженный XML-документ или null, если файл отсутствовал по заданному пути.
(Определяется PluginExtensions)

См. также