EventListener Class

Definition

Namespace:

System.Diagnostics.Tracing

Assembly:

System.Diagnostics.Tracing.dll

Source:

EventSource.cs

Provides methods for enabling and disabling events from event sources.

public ref class EventListener abstract : IDisposable

public abstract class EventListener : IDisposable

type EventListener = class
    interface IDisposable

Public MustInherit Class EventListener
Implements IDisposable

Inheritance

Object

EventListener

Implements

IDisposable

Remarks

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.

Note

This type implements the IDisposable interface. When you have finished using the type, you must dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

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. 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. 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. Listeners receive the events on their OnEventWritten method. Therefore, subclasses of EventListener must override this method to do something useful with the data.

When a new event source is created, the OnEventSourceCreated method is called. Every current event listener gets exactly one OnEventSourceCreated call for every current event source that can send it log messages. 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.

Important

When instantiating an EventListener, the callbacks to OnEventSourceCreated and OnEventWritten can happen before the constructor has completed. Take care when you initialize instance members used in those callbacks.

Constructors

EventListener()

Creates a new instance of the EventListener class.

Methods

DisableEvents(EventSource)	Disables all events for the specified event source.
Dispose()	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. (Inherited from Object)
EventSourceIndex(EventSource)	Gets a small non-negative number that represents the specified event source.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from 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. (Inherited from Object)

Events

EventSourceCreated	Occurs when an event source (EventSource object) is attached to the dispatcher.
EventWritten	Occurs when an event has been written by an event source (EventSource object) for which the event listener has enabled events.