TimerLogger Class |
Creates a simple way to log a timer message to the devlog. The logger writes bracketing start and stop
entries in the devlog. The two entries are tied together with a bracketingID that can be used to
identify a particular entry's matching entry via the F8 key. Entries are logged with Info
severity unless a Warning threshold is provided in the Stop(String, Double) call.
In order to avoid cluttering up the devlog, it is sometimes desirable to write a timer entry if, and only if, some timing threshold is exceeded. Use the ThresholdLogger for this purpose.
Inheritance HierarchyNamespace: NetQuarry
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
SyntaxThe TimerLogger type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TimerLogger(String) |
Creates the object and logs the start message.
|
| TimerLogger(String, String) |
Creates the object with a specific logID.
|
| TimerLogger(String, String, LogCategory) |
Creates the timer object with a specific logID and logCategory
|
| TimerLogger(String, String, String) |
Creates the object with a specific logID.
|
| TimerLogger(String, String, LogCategory, String) |
Creates the timer object with a specific logID, logCategory, and source.
|
Properties| Name | Description | |
|---|---|---|
 | StartTime |
Gets the start time for the timer.
|
| StartTimestamp |
Gets the start timestamp (as written to devlog) for the timer.
|
| StopTime |
Gets the stop time for the timer. Valid only if Stop has been called.
|
| StopTimestamp |
Gets the stop timestamp (as written to devlog) for the timer. Valid only if Stop has been called.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Stop |
Stops the timer and logs the closing message.
|
| Stop(String) |
Stops the timer and logs the closing message with the provided addendum.
|
| Stop(String, Double) |
Stops the timer and logs the closing message with the provided addendum.
If the timer met or exceeded the specified threshold then the entry is logged as a Warning rather than as Info.
|
| ToString | (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
  | TIMER_SOURCE |
Default source for timer log messages
|
Extension Methods| Name | Description | |
|---|---|---|
 | EqualValue |
Determines if the object value is equal to another object. If the two objects are null, then this returns true.
There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways).
If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.) |
See Also