EventSource Class

Definition

Provides the ability to create events for event tracing across platforms.

public ref class EventSource : IDisposable
public class EventSource : IDisposable
type EventSource = class
    interface IDisposable
Public Class EventSource
Implements IDisposable
Inheritance
EventSource
Derived
Implements

Remarks

For more information about this API, see Supplemental API remarks for EventSource.

Constructors

EventSource()

Creates a new instance of the EventSource class.

EventSource(Boolean)

Creates a new instance of the EventSource class and specifies whether to throw an exception when an error occurs in the underlying Windows code.

EventSource(EventSourceSettings)

Creates a new instance of the EventSource class with the specified configuration settings.

EventSource(EventSourceSettings, String[])

Initializes a new instance of the EventSource to be used with non-contract events that contains the specified settings and traits.

EventSource(String)

Creates a new instance of the EventSource class with the specified name.

EventSource(String, EventSourceSettings)

Creates a new instance of the EventSource class with the specified name and settings.

EventSource(String, EventSourceSettings, String[])

Creates a new instance of the EventSource class with the specified configuration settings.

Properties

ConstructionException

Gets any exception that was thrown during the construction of the event source.

CurrentThreadActivityId

Gets the activity ID of the current thread.

Guid

The unique identifier for the event source.

Name

The friendly name of the class that is derived from the event source.

Settings

Gets the settings applied to this event source.

Methods

Dispose()

Releases all resources used by the current instance of the EventSource class.

Dispose(Boolean)

Releases the unmanaged resources used by the EventSource class and optionally releases the managed resources.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Finalize()

Allows the EventSource object to attempt to free resources and perform other cleanup operations before the object is reclaimed by garbage collection.

GenerateManifest(Type, String)

Returns a string of the XML manifest that is associated with the current event source.

GenerateManifest(Type, String, EventManifestOptions)

Returns a string of the XML manifest that is associated with the current event source.

GetGuid(Type)

Gets the unique identifier for this implementation of the event source.

GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetName(Type)

Gets the friendly name of the event source.

GetSources()

Gets a snapshot of all the event sources for the application domain.

GetTrait(String)

Gets the trait value associated with the specified key.

GetType()

Gets the Type of the current instance.

(Inherited from Object)
IsEnabled()

Determines whether the current event source is enabled.

IsEnabled(EventLevel, EventKeywords)

Determines whether the current event source that has the specified level and keyword is enabled.

IsEnabled(EventLevel, EventKeywords, EventChannel)

Determines whether the current event source is enabled for events with the specified level, keywords and channel.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnEventCommand(EventCommandEventArgs)

Called when the current event source is updated by the controller.

SendCommand(EventSource, EventCommand, IDictionary<String,String>)

Sends a command to a specified event source.

SetCurrentThreadActivityId(Guid)

Sets the activity ID on the current thread.

SetCurrentThreadActivityId(Guid, Guid)

Sets the activity ID on the current thread, and returns the previous activity ID.

ToString()

Obtains a string representation of the current event source instance.

ToString()

Returns a string that represents the current object.

(Inherited from Object)
Write(String)

Writes an event without fields, but with the specified name and default options.

Write(String, EventSourceOptions)

Writes an event without fields, but with the specified name and options.

Write<T>(String, EventSourceOptions, Guid, Guid, T)

Writes an event with the specified name, options, related activity and event data.

Write<T>(String, EventSourceOptions, T)

Writes an event with the specified name, event data and options.

Write<T>(String, EventSourceOptions, T)

Writes an event with the specified name, options and event data.

Write<T>(String, T)

Writes an event with the specified name and data.

WriteEvent(Int32)

Writes an event by using the provided event identifier.

WriteEvent(Int32, Byte[])

Writes an event by using the provided event identifier and byte array argument.

WriteEvent(Int32, EventSource+EventSourcePrimitive[])

Writes an event by using the provided event identifier and a variable number of event source primitives.

WriteEvent(Int32, Int32)

Writes an event by using the provided event identifier and 32-bit integer argument.

WriteEvent(Int32, Int32, Int32)

Writes an event by using the provided event identifier and 32-bit integer arguments.

WriteEvent(Int32, Int32, Int32, Int32)

Writes an event by using the provided event identifier and 32-bit integer arguments.

WriteEvent(Int32, Int32, String)

Writes an event by using the provided event identifier and 32-bit integer and string arguments.

WriteEvent(Int32, Int64)

Writes an event by using the provided event identifier and 64-bit integer argument.

WriteEvent(Int32, Int64, Byte[])

Writes the event data using the specified identifier and 64-bit integer and byte array arguments.

WriteEvent(Int32, Int64, Int64)

Writes an event by using the provided event identifier and 64-bit arguments.

WriteEvent(Int32, Int64, Int64, Int64)

Writes an event by using the provided event identifier and 64-bit arguments.

WriteEvent(Int32, Int64, String)

Writes an event by using the provided event identifier and 64-bit integer, and string arguments.

WriteEvent(Int32, Object[])

Writes an event by using the provided event identifier and array of arguments.

WriteEvent(Int32, String)

Writes an event by using the provided event identifier and string argument.

WriteEvent(Int32, String, Int32)

Writes an event by using the provided event identifier and arguments.

WriteEvent(Int32, String, Int32, Int32)

Writes an event by using the provided event identifier and arguments.

WriteEvent(Int32, String, Int64)

Writes an event by using the provided event identifier and arguments.

WriteEvent(Int32, String, String)

Writes an event by using the provided event identifier and string arguments.

WriteEvent(Int32, String, String, String)

Writes an event by using the provided event identifier and string arguments.

WriteEventCore(Int32, Int32, EventSource+EventData*)

Creates a new WriteEvent overload by using the provided event identifier and event data.

WriteEventWithRelatedActivityId(Int32, Guid, Object[])

Writes an event that indicates that the current activity is related to another activity.

WriteEventWithRelatedActivityIdCore(Int32, Guid*, Int32, EventSource+EventData*)

Writes an event that indicates that the current activity is related to another activity.

Events

EventCommandExecuted

Occurs when a command comes from an event listener.

Applies to

Thread Safety

This type is thread safe.