Class JobQueue<TArgs>

Inheritance

System.Object

JobQueue<TArgs>

Implements

IJobQueue<TArgs>

IRunnable

IDisposable

Namespace: Volo.Abp.BackgroundJobs.RabbitMQ

Assembly: Volo.Abp.BackgroundJobs.RabbitMQ.dll

Syntax

public class JobQueue<TArgs> : object, IJobQueue<TArgs>, IRunnable, IDisposable

Type Parameters

Name	Description
TArgs

Constructors

JobQueue(IOptions<AbpBackgroundJobOptions>, IOptions<AbpRabbitMqBackgroundJobOptions>, IChannelPool, IRabbitMqSerializer, IBackgroundJobExecuter, IServiceScopeFactory, IExceptionNotifier)

Declaration

public JobQueue(IOptions<AbpBackgroundJobOptions> backgroundJobOptions, IOptions<AbpRabbitMqBackgroundJobOptions> rabbitMqAbpBackgroundJobOptions, IChannelPool channelPool, IRabbitMqSerializer serializer, IBackgroundJobExecuter jobExecuter, IServiceScopeFactory serviceScopeFactory, IExceptionNotifier exceptionNotifier)

Parameters

Type	Name	Description
IOptions<AbpBackgroundJobOptions>	backgroundJobOptions
IOptions<AbpRabbitMqBackgroundJobOptions>	rabbitMqAbpBackgroundJobOptions
IChannelPool	channelPool
IRabbitMqSerializer	serializer
IBackgroundJobExecuter	jobExecuter
IServiceScopeFactory	serviceScopeFactory
IExceptionNotifier	exceptionNotifier

Fields

SyncObj

Declaration

protected SemaphoreSlim SyncObj

Field Value

Type	Description
SemaphoreSlim

Properties

AbpBackgroundJobOptions

Declaration

protected AbpBackgroundJobOptions AbpBackgroundJobOptions { get; }

Property Value

Type	Description
AbpBackgroundJobOptions

AbpRabbitMqBackgroundJobOptions

Declaration

protected AbpRabbitMqBackgroundJobOptions AbpRabbitMqBackgroundJobOptions { get; }

Property Value

Type	Description
AbpRabbitMqBackgroundJobOptions

ChannelAccessor

Declaration

protected IChannelAccessor ChannelAccessor { get; }

Property Value

Type	Description
IChannelAccessor

ChannelPool

Declaration

protected IChannelPool ChannelPool { get; }

Property Value

Type	Description
IChannelPool

Consumer

Declaration

protected EventingBasicConsumer Consumer { get; }

Property Value

Type	Description
EventingBasicConsumer

ExceptionNotifier

Declaration

protected IExceptionNotifier ExceptionNotifier { get; }

Property Value

Type	Description
IExceptionNotifier

IsDiposed

Declaration

protected bool IsDiposed { get; }

Property Value

Type	Description
System.Boolean

JobConfiguration

Declaration

protected BackgroundJobConfiguration JobConfiguration { get; }

Property Value

Type	Description
BackgroundJobConfiguration

JobExecuter

Declaration

protected IBackgroundJobExecuter JobExecuter { get; }

Property Value

Type	Description
IBackgroundJobExecuter

Logger

Declaration

public ILogger<JobQueue<TArgs>> Logger { get; set; }

Property Value

Type	Description
ILogger<JobQueue<TArgs>>

QueueConfiguration

Declaration

protected JobQueueConfiguration QueueConfiguration { get; }

Property Value

Type	Description
JobQueueConfiguration

Serializer

Declaration

protected IRabbitMqSerializer Serializer { get; }

Property Value

Type	Description
IRabbitMqSerializer

ServiceScopeFactory

Declaration

protected IServiceScopeFactory ServiceScopeFactory { get; }

Property Value

Type	Description
IServiceScopeFactory

Methods

CheckDisposed()

Declaration

protected void CheckDisposed()

CreateBasicPropertiesToPublish()

Declaration

protected virtual IBasicProperties CreateBasicPropertiesToPublish()

Returns

Type	Description
IBasicProperties

Dispose()

Declaration

public virtual void Dispose()

EnqueueAsync(TArgs, BackgroundJobPriority, Nullable<TimeSpan>)

Declaration

public virtual Task<string> EnqueueAsync(TArgs args, BackgroundJobPriority priority = default(BackgroundJobPriority), TimeSpan? delay = null)

Parameters

Type	Name	Description
TArgs	args
BackgroundJobPriority	priority
System.Nullable<TimeSpan>	delay

Returns

Type	Description
Task<System.String>

EnsureInitializedAsync()

Declaration

protected virtual Task EnsureInitializedAsync()

Returns

Type	Description
Task

GetOrCreateJobQueueConfiguration()

Declaration

protected virtual JobQueueConfiguration GetOrCreateJobQueueConfiguration()

Returns

Type	Description
JobQueueConfiguration

MessageReceived(Object, BasicDeliverEventArgs)

Declaration

protected virtual void MessageReceived(object sender, BasicDeliverEventArgs ea)

Parameters

Type	Name	Description
System.Object	sender
BasicDeliverEventArgs	ea

PublishAsync(TArgs, BackgroundJobPriority, Nullable<TimeSpan>)

Declaration

protected virtual Task PublishAsync(TArgs args, BackgroundJobPriority priority = default(BackgroundJobPriority), TimeSpan? delay = null)

Parameters

Type	Name	Description
TArgs	args
BackgroundJobPriority	priority
System.Nullable<TimeSpan>	delay

Returns

Type	Description
Task

StartAsync(CancellationToken)

Declaration

public virtual Task StartAsync(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task

StopAsync(CancellationToken)

Declaration

public virtual Task StopAsync(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task

Implements

IJobQueue<TArgs>

IRunnable

IDisposable

Extension Methods

AbpObjectExtensions.As<T>(Object)

AbpObjectExtensions.To<T>(Object)

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

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

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

LockExtensions.Locking(Object, Action)

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

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

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