Table of Contents

Class ThreadQueueWorker<TItem, TWorker>

Namespace
CMS.Base
Assembly
CMS.Base.dll

Worker processing queue in single (one per application and generic variant), ever-running asynchronous thread

public abstract class ThreadQueueWorker<TItem, TWorker> : ThreadWorker<TWorker> where TItem : class where TWorker : ThreadQueueWorker<TItem, TWorker>, new()

Type Parameters

TItem
TWorker
Inheritance
object
ThreadWorker<TWorker>
ThreadQueueWorker<TItem, TWorker>
Derived
Inherited Members
Extension Methods

Fields

Events

Events fired by the worker

public readonly ThreadQueueWorkerEvents<TItem, TWorker> Events

Field Value

ThreadQueueWorkerEvents<TItem, TWorker>

Properties

CheckDuplicity

If true, the queue checks the duplicity when inserting items. The duplicity is checked using the default comparer of the item.

protected virtual bool CheckDuplicity { get; }

Property Value

bool

ItemsInQueue

Return the current number of items in the queue

public int ItemsInQueue { get; }

Property Value

int

Methods

Enqueue(TItem, bool)

Adds new item to processing queue.

public void Enqueue(TItem newItem, bool ensureThread = true)

Parameters

newItem TItem

Adds the item to the queue

ensureThread bool

If true, the processing thread is ensured

Process()

Method processing queued actions.

protected override sealed void Process()

ProcessItem(TItem)

Processes the item in the queue. Override this method to process a single item from the queue.

protected abstract void ProcessItem(TItem item)

Parameters

item TItem

Item to process.

Remarks

If exception from override arises, the thread will not end, the rest of queue will be processed, but exception will not be logged. Please consider implementing exception handling mechanism.

ProcessItems(IEnumerable<TItem>)

Processes the given list of items. Override this method to process queued items as a bulk. Returns the number of processed items.

protected virtual int ProcessItems(IEnumerable<TItem> items)

Parameters

items IEnumerable<TItem>

Worker queue.

Returns

int