|
Log
|
A publisher of log messages.
Inheritance Hierarchy
Namespace: GSF.Diagnostics
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
SyntaxThe LogPublisher type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | MaxDistinctEventPublisherCount | The maximum number of distinct events that this publisher can generate. (Default: 20) |
Methods| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| 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) |
| Publish(MessageLevel, String, String, String, Exception) | Raises a log message with the provided data. |
| Publish(MessageLevel, MessageFlags, String, String, String, Exception) | Raises a log message with the provided data. |
| RegisterEvent(MessageLevel, String) | Initializes an LogEventPublisher with the provided values. |
| RegisterEvent(MessageLevel, MessageFlags, String) | Initializes an LogEventPublisher with the provided values. |
| RegisterEvent(MessageLevel, String, Int32, MessageRate, Int32) | Initializes an LogEventPublisher with the provided values. |
| RegisterEvent(MessageLevel, MessageFlags, String, Int32, MessageRate, Int32) | Initializes an LogEventPublisher with the provided values. |
| ToString |
Gets the full name of the type.
(Overrides ObjectToString) |
Fields| Name | Description | |
|---|---|---|
 | InitialStackMessages | The stack messages that existed when this publisher was created. This can be modified by the user of this publisher. Any messages that get published by this class will automatically have this data added to the log message. |
| InitialStackTrace | The stack trace that existed when this publisher was created. This can be modified by the user of this publisher. Any messages that get published by this class will automatically have this data added to the log message. |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
RemarksInitialStackMessages and InitialStackTrace can be modified so messages that are generated
with this instance will have this data appended to the log message.
The user can either call one of the Publish overloads to lazily publish a message, or they
can register a message with RegisterEvent so calling this message will incur little overhead.
If registering an event, the user can check HasSubscribers to determine if the log message can be skipped altogether.
Registering events also allows the user to specify the auto-suppression algorithm and the depth of the stack trace that will be recorded on a message being raised.
See Also