Class BackgroundJobWorker

Inheritance

object

BackgroundWorkerBase

AsyncPeriodicBackgroundWorkerBase

BackgroundJobWorker

Implements

IBackgroundJobWorker

IBackgroundWorker

IRunnable

ISingletonDependency

Inherited Members

AsyncPeriodicBackgroundWorkerBase.StartAsync(CancellationToken)

AsyncPeriodicBackgroundWorkerBase.StopAsync(CancellationToken)

AsyncPeriodicBackgroundWorkerBase.ServiceScopeFactory

AsyncPeriodicBackgroundWorkerBase.Timer

AsyncPeriodicBackgroundWorkerBase.StartCancellationToken

BackgroundWorkerBase.ToString()

BackgroundWorkerBase.LazyServiceProvider

BackgroundWorkerBase.ServiceProvider

BackgroundWorkerBase.LoggerFactory

BackgroundWorkerBase.Logger

BackgroundWorkerBase.StoppingTokenSource

BackgroundWorkerBase.StoppingToken

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
IOptions<AbpBackgroundJobOptions>	jobOptions
IOptions<AbpBackgroundJobWorkerOptions>	workerOptions
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
DateTime?

DoWorkAsync(PeriodicBackgroundWorkerContext)

Declaration

protected override Task DoWorkAsync(PeriodicBackgroundWorkerContext workerContext)

Parameters

Type	Name	Description
PeriodicBackgroundWorkerContext	workerContext

Returns

Type	Description
Task

Overrides

AsyncPeriodicBackgroundWorkerBase.DoWorkAsync(PeriodicBackgroundWorkerContext)

TryUpdateAsync(IBackgroundJobStore, BackgroundJobInfo)

Declaration

protected virtual Task TryUpdateAsync(IBackgroundJobStore store, BackgroundJobInfo jobInfo)

Parameters

Type	Name	Description
IBackgroundJobStore	store
BackgroundJobInfo	jobInfo

Returns

Type	Description
Task

Implements

IBackgroundJobWorker

IBackgroundWorker

IRunnable

ISingletonDependency

Extension Methods

AbpObjectExtensions.As<T>(object)

AbpObjectExtensions.To<T>(object)

LockExtensions.Locking(object, Action)

LockExtensions.Locking<TResult>(object, Func<TResult>)

AbpObjectExtensions.If<T>(T, bool, Action<T>)

AbpObjectExtensions.If<T>(T, bool, Func<T, T>)

AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)

AbpObjectExtensions.IsIn<T>(T, params T[])

AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)

AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)

AbpOpenIddictQueryableExtensions.SkipIf<T, TQueryable>(TQueryable, bool, int?)

AbpOpenIddictQueryableExtensions.TakeIf<T, TQueryable>(TQueryable, bool, int?)

LockExtensions.Locking<T>(T, Action<T>)

LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)