Class BackgroundJobWorker

Inheritance
object
BackgroundWorkerBase
AsyncPeriodicBackgroundWorkerBase
BackgroundJobWorker
Implements
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Volo.Abp.BackgroundJobs
Assembly: Volo.Abp.BackgroundJobs.dll
Syntax
public class BackgroundJobWorker : AsyncPeriodicBackgroundWorkerBase, IBackgroundJobWorker, IBackgroundWorker, IRunnable, ISingletonDependency

Constructors

BackgroundJobWorker(AbpAsyncTimer, IOptions<AbpBackgroundJobOptions>, IOptions<AbpBackgroundJobWorkerOptions>, IServiceScopeFactory, IAbpDistributedLock)

Declaration
public BackgroundJobWorker(AbpAsyncTimer timer, IOptions<AbpBackgroundJobOptions> jobOptions, IOptions<AbpBackgroundJobWorkerOptions> workerOptions, IServiceScopeFactory serviceScopeFactory, IAbpDistributedLock distributedLock)
Parameters
Type Name Description
AbpAsyncTimer timer
Microsoft.Extensions.Options.IOptions<TOptions><AbpBackgroundJobOptions> jobOptions
Microsoft.Extensions.Options.IOptions<TOptions><AbpBackgroundJobWorkerOptions> workerOptions
Microsoft.Extensions.DependencyInjection.IServiceScopeFactory serviceScopeFactory
IAbpDistributedLock distributedLock

Fields

DistributedLockName

Declaration
protected const string DistributedLockName = "AbpBackgroundJobWorker"
Field Value
Type Description
string

Properties

DistributedLock

Declaration
protected IAbpDistributedLock DistributedLock { get; }
Property Value
Type Description
IAbpDistributedLock

JobOptions

Declaration
protected AbpBackgroundJobOptions JobOptions { get; }
Property Value
Type Description
AbpBackgroundJobOptions

WorkerOptions

Declaration
protected AbpBackgroundJobWorkerOptions WorkerOptions { get; }
Property Value
Type Description
AbpBackgroundJobWorkerOptions

Methods

CalculateNextTryTime(BackgroundJobInfo, IClock)

Declaration
protected virtual DateTime? CalculateNextTryTime(BackgroundJobInfo jobInfo, IClock clock)
Parameters
Type Name Description
BackgroundJobInfo jobInfo
IClock clock
Returns
Type Description
System.DateTime?

DoWorkAsync(PeriodicBackgroundWorkerContext)

Declaration
protected override Task DoWorkAsync(PeriodicBackgroundWorkerContext workerContext)
Parameters
Type Name Description
PeriodicBackgroundWorkerContext workerContext
Returns
Type Description
System.Threading.Tasks.Task
Overrides

TryUpdateAsync(IBackgroundJobStore, BackgroundJobInfo)

Declaration
protected virtual Task TryUpdateAsync(IBackgroundJobStore store, BackgroundJobInfo jobInfo)
Parameters
Type Name Description
IBackgroundJobStore store
BackgroundJobInfo jobInfo
Returns
Type Description
System.Threading.Tasks.Task

Implements

Extension Methods