Try our conversational search powered by Generative AI!

AI OnAI Off

Class SchedulerService

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice.

Inheritance
System.Object
SchedulerService
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Scheduler.Internal
Assembly: EPiServer.dll
Version: 11.20.7
Syntax
[ServiceConfiguration(Lifecycle = ServiceInstanceScope.Singleton, ServiceType = typeof(ISchedulerService))]
public class SchedulerService : 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

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Current scheduler job

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

WaitOnException

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. 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

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. 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()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. 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()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Execute the job

Declaration
protected virtual void Execute()

ExecuteJob()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Execute the job

Declaration
protected virtual void ExecuteJob()

GetNextScheduledJob()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. 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)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice.

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