Click or drag to resize

EventTimer Class

A reoccurring timer that fires on a given interval. This event timer will always fire at the top of the specified interval. If the callback takes too long, the next interval will be skipped.
Inheritance Hierarchy
SystemObject
  GSF.DiagnosticsDisposableLoggingClassBase
    GSF.ThreadingEventTimer

Namespace: GSF.Threading
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax
public class EventTimer : DisposableLoggingClassBase
View Source

The EventTimer type exposes the following members.

Properties
 NameDescription
Protected propertyLog The LogPublisher for logging messages.
(Inherited from DisposableLoggingClassBase)
Public propertyTimeUntilNextExecution The amount of time before the next interval will occur.
Top
Methods
 NameDescription
Public methodChangeTimer Modifies the timer. Note, it takes some time for this timer to go into effect.
Protected methodCheckDisposed Checks if the class has been disposed, throws an exception if this is the case.
(Inherited from DisposableLoggingClassBase)
Public methodStatic memberCreate Creates a EventTimer on the specified interval.
Public methodStatic memberCreateHours Creates a EventTimer on the specified interval.
Public methodStatic memberCreateMinutes Creates a EventTimer on the specified interval.
Public methodStatic memberCreateSeconds Creates a EventTimer on the specified interval.
Public methodDispose Releases all the resources used by the DisposableLoggingClassBase object.
(Inherited from DisposableLoggingClassBase)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the DisposableLoggingClassBase object and optionally releases the managed resources.
(Overrides DisposableLoggingClassBaseDispose(Boolean))
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize This code is here to detect when finalizers are called rather than a class be properly disposed.
(Inherited from DisposableLoggingClassBase)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodRunNow Immediately executes the timer, not waiting for the elapsed interval.
Public methodStart Starts the watching
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventElapsed An event that fires every time the specified period elapses.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also