SharedTimer Class

Represents a timer class that will group registered timer event callbacks that operate on the same interval in order to optimize thread pool queuing.

Inheritance Hierarchy

SystemObject
GSF.ThreadingSharedTimer

Namespace: GSF.Threading
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8

Syntax

C++

JavaScript

Copy

public sealed class SharedTimer : IDisposable

Public NotInheritable Class SharedTimer
	Implements IDisposable

public ref class SharedTimer sealed : IDisposable

[<SealedAttribute>]
type SharedTimer = 
    class
        interface IDisposable
    end

GSF.Threading.SharedTimer = function();

Type.createClass(
	'GSF.Threading.SharedTimer',
	null,
	IDisposable);

View Source

The SharedTimer type exposes the following members.

Properties

	Name	Description
	AutoReset	Gets or sets flag that indicates whether the SharedTimer should raise the Elapsed event only once false or repeatedly true.
	Enabled	Gets or sets flag that indicates whether the SharedTimer should raise the Elapsed event.
	Interval	Gets or sets the interval at which to raise the Elapsed event.

Top

Methods

	Name	Description
	Close	Stops the timer.
	Dispose	Stops the timer and prevents reuse of the class.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Start	Starts raising the Elapsed event by setting Enabled to true.
	Stop	Stops raising the Elapsed event by setting Enabled to false.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Events

	Name	Description
	Elapsed	Occurs when the timer interval elapses.
	UnhandledExceptions	Occurs when Elapsed event throws an exception.

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

Remarks

Externally the SharedTimer operations similar to the Timer. Internally the timer pools callbacks with the same Interval into a single timer where each callback is executed on the same thread, per instance of the SharedTimerScheduler.

Any long running callbacks that have a risk of long delays should not use SharedTimer as this will effect the reliability of all of the other SharedTimer instances for a given SharedTimerScheduler.

Reference

GSF.Threading Namespace