Plugin - класс

Базовый класс для асинхронного плагина.

Definition

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

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

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

Свойства

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 Метод, вызываемый хостом при вежливой остановке плагина. Он должен максимально быстро завершить выполнение плагина, но не завершать свою работу до тех пор, пока потоки, с которыми работает плагин, не будут завершены. Реализация по умолчанию устанавливает свойство StopRequested, после чего ожидает завершение метода EntryPointAsync(CancellationToken).
ToStringReturns a string that represents the current object.
(Унаследован от Object)

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

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

См. также