EventListener Класс

Определение

Предоставляет методы для включения и отключения событий из источников событий.Provides methods for enabling and disabling events from event sources.

public ref class EventListener abstract : IDisposable
public ref class EventListener : IDisposable
public abstract class EventListener : IDisposable
public class EventListener : IDisposable
type EventListener = class
    interface IDisposable
Public MustInherit Class EventListener
Implements IDisposable
Public Class EventListener
Implements IDisposable
Наследование
EventListener
Реализации

Комментарии

Прослушиватель событий представляет целевой объект для всех событий, создаваемых реализациями источника события ( EventSource Object) в текущем домене приложения.An event listener represents the target for all events generated by event source (EventSource object) implementations in the current application domain. При создании нового прослушивателя событий он логически присоединяется ко всем источникам событий в этом домене приложения.When a new event listener is created, it is logically attached to all event sources in that application domain.

Примечание

Этот тип реализует интерфейс IDisposable.This type implements the IDisposable interface. После завершения использования типа его необходимо удалить прямо или косвенно.When you have finished using the type, you must dispose of it either directly or indirectly. Чтобы сделать это прямо, вызовите его метод Dispose в блоке try/catch.To dispose of the type directly, call its Dispose method in a try/catch block. Чтобы сделать это косвенно, используйте языковые конструкции, такие как using (в C#) или Using (в Visual Basic).To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). Дополнительные сведения см. в разделе "Использование объекта, реализующего IDisposable" в статье об интерфейсе IDisposable.For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

Прослушиватель событий может включать или отключать для каждого текущего источника событий с помощью уровней событий ( EventLevel ) и ключевых слов события ( EventKeywords ), чтобы дополнительно ограничить набор событий, отправляемых прослушивателю.An event listener can enable or disable on a per-current event source basis by using event levels (EventLevel) and event keywords (EventKeywords) to further restrict the set of events to be sent to the listener. Прослушиватель также может передавать произвольные команды конкретному текущему источнику событий с помощью SendCommand метода.The listener can also send arbitrary commands to a specific current event source by using the SendCommand method. Значения команд относятся к реализации источника события.The meanings of the commands are specific to the implementation of the event source.

В одном домене приложения можно определить несколько прослушивателей событий.Multiple event listeners can be defined in a single application domain. Каждый прослушиватель логически не зависит от других прослушивателей, чтобы события, включенные или отключенные одним прослушивателем, влияли только на этот прослушиватель.Each listener is logically independent of the other listeners so that events that are enabled or disabled by one listener affect only that listener. Команды, отправляемые с помощью SendCommand метода, могут выполнять семантические операции (например, сбор мусора или сброс данных), которые влияют на другие прослушиватели, но это исключение, а не правило.It is possible for commands sent with the SendCommand method to do a semantic operation (such as a garbage collection or flushing data) that affects the other listeners, but this is the exception rather than the rule.

Каждый источник событий хранит список прослушивателей событий, к которым он отправляет события.Each event source keeps a list of event listeners that it sends events to. Набор критериев фильтрации связан с каждой парой прослушивателей источника события.A set of filtering criteria is associated with each event source-listener pair. Эти критерии определяют события, которые будут получены прослушивателем для текущего источника событий.These criteria determine the events that listener will receive for the current event source. Прослушиватели получают события в своем OnEventWritten методе.Listeners receive the events on their OnEventWritten method. Таким образом, подклассы EventListener должны переопределять этот метод, чтобы сделать что-то полезное с данными.Therefore, subclasses of EventListener must override this method to do something useful with the data.

При создании нового источника события OnEventSourceCreated вызывается метод.When a new event source is created, the OnEventSourceCreated method is called. Каждый текущий прослушиватель событий получает ровно один OnEventSourceCreated вызов для каждого текущего источника событий, который может отправить сообщения журнала.Every current event listener gets exactly one OnEventSourceCreated call for every current event source that can send it log messages. При создании прослушивателя событий OnEventSourceCreated выполняется ряд вызовов для уведомления нового прослушивателя всех источников событий, существовавших до создания прослушивателя.When an event listener is created, a series of OnEventSourceCreated calls are made to notify the new listener of all the event sources that existed before the listener was created.

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

EventListener()

Создает новый экземпляр класса EventListener.Creates a new instance of the EventListener class.

Методы

DisableEvents(EventSource)

Отключает все события для заданного источника события.Disables all events for the specified event source.

Dispose()

Освобождает ресурсы, используемые текущим экземпляром класса EventListener.Releases the resources used by the current instance of the EventListener class.

EnableEvents(EventSource, EventLevel)

Включает события для заданного источника событий, который содержит указанный уровень детализации или ниже.Enables events for the specified event source that has the specified verbosity level or lower.

EnableEvents(EventSource, EventLevel, EventKeywords)

Включает события для заданного источника события, который содержит указанный уровень детализации или ниже, и соответствующие флаги ключевого слова.Enables events for the specified event source that has the specified verbosity level or lower, and matching keyword flags.

EnableEvents(EventSource, EventLevel, EventKeywords, IDictionary<String,String>)

Включает события для заданного источника события, который содержит указанный уровень детализации или ниже, соответствующие флаги ключевого слова и аргументы.Enables events for the specified event source that has the specified verbosity level or lower, matching event keyword flag, and matching arguments.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
EventSourceIndex(EventSource)

Возвращает маленькое неотрицательное число, представляющее указанный источник события.Gets a small non-negative number that represents the specified event source.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
OnEventSourceCreated(EventSource)

Вызывается для всех существующих источников событий, когда прослушиватель события создан и когда новый источник события вложен в прослушиватель.Called for all existing event sources when the event listener is created and when a new event source is attached to the listener.

OnEventWritten(EventWrittenEventArgs)

Вызывается, когда событие было записано источником события, для которого прослушиватель события включил события.Called whenever an event has been written by an event source for which the event listener has enabled events.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

События

EventSourceCreated

Происходит, когда источник событий (объект EventSource) подключается к диспетчеру.Occurs when an event source (EventSource object) is attached to the dispatcher.

EventWritten

Происходит, когда событие записано источником события (объектом EventSource), для которого прослушиватель события включил события.Occurs when an event has been written by an event source (EventSource object) for which the event listener has enabled events.

Применяется к