SchedulingTimer Class

Class to provide timing for scheduler.

Inheritance Hierarchy

System.Object
  CMS.Scheduler.SchedulingTimer

Namespace: CMS.Scheduler
Assembly: CMS.Scheduler (in CMS.Scheduler.dll) Version: 8.2.23

Syntax

public class SchedulingTimer

The SchedulingTimer type exposes the following members.

Constructors

	Name	Description
Public method	SchedulingTimer	Creates thread which calls SchedulerExecutor periodicaly.

Methods

	Name	Description
Public method Static member	CreateTimer	Creates a timer for specified site name.
Public method Static member	EnsureTimer	Ensures the scheduling timer.
Public method	Execute	Downloads scheduler.aspx once.
Public method	ExecuteAsync	Executes the request in an asynchronous thread.
Public method Static member	RequestRun	Requests scheduler run for specified site name, updates the Last runs HashTable and returns true if the scheduler run is allowed.
Public method Static member	RestartTimer	Restarts the given site timer.
Public method	Run	Downloads scheduler.aspx in neverending loop.
Public method Static member	RunSchedulerASAP	Initializes the site scheduler to run ASAP.
Public method	RunTimerAsync	Runs the timer in an asynchronous thread.
Public method Static member	StopTimer	Stops the specified timer.
Public method Static member	StopTimers	Stops all the timers.
Public method Static member	TimerExists	Returns true if specified site timer exists.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mCancel	If true, the timer cancels execution.
Protected field	mRunning	If true, the timer is running.

Properties

	Name	Description
Public property Static member	LastRuns	Last timer run.
Public property Static member	RunSchedulerImmediately	If true, the scheduler runs immediately after the request finishes.
Public property Static member	SchedulerRunImmediatelySiteName	Gets or sets the site name which should be used for immediate run
Public property	ScheduleURL	Schedule URL.