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.181-beta

Syntax

C++

JavaScript

Copy

public class EventTimer : DisposableLoggingClassBase

Public Class EventTimer
	Inherits DisposableLoggingClassBase

public ref class EventTimer : public DisposableLoggingClassBase

type EventTimer = 
    class
        inherit DisposableLoggingClassBase
    end

GSF.Threading.EventTimer = function();

Type.createClass(
	'GSF.Threading.EventTimer',
	GSF.Diagnostics.DisposableLoggingClassBase);

View Source

The EventTimer type exposes the following members.

Properties

	Name	Description
	Log	The LogPublisher for logging messages. (Inherited from DisposableLoggingClassBase)
	TimeUntilNextExecution	The amount of time before the next interval will occur.

Top

Methods

	Name	Description
	ChangeTimer	Modifies the timer. Note, it takes some time for this timer to go into effect.
	CheckDisposed	Checks if the class has been disposed, throws an exception if this is the case. (Inherited from DisposableLoggingClassBase)
	Create	Creates a EventTimer on the specified interval.
	CreateHours	Creates a EventTimer on the specified interval.
	CreateMinutes	Creates a EventTimer on the specified interval.
	CreateSeconds	Creates a EventTimer on the specified interval.
	Dispose	Releases all the resources used by the DisposableLoggingClassBase object. (Inherited from DisposableLoggingClassBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the DisposableLoggingClassBase object and optionally releases the managed resources. (Overrides DisposableLoggingClassBaseDispose(Boolean))
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	This code is here to detect when finalizers are called rather than a class be properly disposed. (Inherited from DisposableLoggingClassBase)
	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)
	RunNow	Immediately executes the timer, not waiting for the elapsed interval.
	Start	Starts the watching
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Events

	Name	Description
	Elapsed	An event that fires every time the specified period elapses.

Top

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)

Top

Reference

GSF.Threading Namespace