SaaS CMS has officially launched! Learn more now.

Class SchedulerService

Inheritance
System.Object
SchedulerService
Implements
System.IDisposable
Namespace: EPiServer.Scheduler.Internal
Assembly: EPiServer.dll
Version: 12.0.3
Syntax
[ServiceConfiguration]
public class SchedulerService : Object, ISchedulerService, IDisposable

Constructors

SchedulerService(IScheduledJobRepository, IScheduledJobExecutor, FailedScheduledJobRegistry, SchedulerOptions)

Declaration
public SchedulerService(IScheduledJobRepository repository, IScheduledJobExecutor executor, FailedScheduledJobRegistry failedJobRegistry, SchedulerOptions schedulerOptions)
Parameters
Type Name Description
IScheduledJobRepository repository
IScheduledJobExecutor executor
FailedScheduledJobRegistry failedJobRegistry
SchedulerOptions schedulerOptions

Properties

CurrentScheduledItem

Current scheduler job

Declaration
protected virtual ScheduledItem CurrentScheduledItem { get; set; }
Property Value
Type Description
ScheduledItem

WaitOnException

Amount of time to wait if the scheduler can not execute the job

Declaration
public virtual TimeSpan WaitOnException { get; set; }
Property Value
Type Description
System.TimeSpan

WaitOnStop

Amount of time to wait for jobs to complete when stopping the service

Declaration
public virtual TimeSpan WaitOnStop { get; set; }
Property Value
Type Description
System.TimeSpan

Methods

ClearScheduledItem()

Clear the current job

Declaration
protected virtual void ClearScheduledItem()

Dispose()

Declaration
public void Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Execute()

Execute the job

Declaration
protected virtual void Execute()

ExecuteJob()

Execute the job

Declaration
protected virtual void ExecuteJob()

GetNextScheduledJob()

Get the next job up for execution

Declaration
public virtual ScheduledJob GetNextScheduledJob()
Returns
Type Description
ScheduledJob

A ScheduledJob instance if there is a waiting job, otherwise null.

Run()

Declaration
public virtual void Run()

Run(WaitableTimer, Int32, CancellationToken)

Declaration
public virtual void Run(WaitableTimer waitableTimer, int refreshInterval, CancellationToken cancellationToken)
Parameters
Type Name Description
WaitableTimer waitableTimer
System.Int32 refreshInterval
System.Threading.CancellationToken cancellationToken

Stop()

Declaration
public virtual void Stop()

Implements

System.IDisposable

Extension Methods