ThreadQueueWorker<TItem, TWorker> Class

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

Inheritance Hierarchy

System.Object
  CMS.Base.ThreadWorker<TWorker>
    CMS.Base.ThreadQueueWorker<TItem, TWorker>
      CMS.Base.SimpleQueueWorker<T>

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 13.0.131

Syntax

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

Type Parameters

TItem

TWorker

The ThreadQueueWorker<TItem, TWorker> type exposes the following members.

Constructors

	Name	Description
Protected method	ThreadQueueWorker<TItem, TWorker>

Fields

	Name	Description
Public field	Events	Events fired by the worker
Protected field	SyncRoot	Lock this object when doing actions that might change the result of condition run while stopping execution (Inherited from ThreadWorker<T>.)

Properties

	Name	Description
Protected property	CheckDuplicity	If true, the queue checks the duplicity when inserting items. The duplicity is checked using the default comparer of the item.
Protected property	DefaultInterval	Gets the default interval in milliseconds for the worker. (Inherited from ThreadWorker<T>.)
Public property	ItemsInQueue	Return the current number of items in the queue
Protected property	MaintenanceInterval	Gets the maintenance interval in milliseconds for the worker. When 0 (default), the maintenance is not performed. (Inherited from ThreadWorker<T>.)
Protected property	PollThread	Gets or sets thread which is periodically checking for new tasks. (Inherited from ThreadWorker<T>.)
Public property	ProcessingPaused	Indicates whether worker routine is temporarily paused. (Inherited from ThreadWorker<T>.)
Protected property	StopRequestToken	The CancellationToken to be checked if the thread should stop execution. (Inherited from ThreadWorker<T>.)
Protected property	UseLogContext	If true, the thread uses a log context for its operations (Inherited from ThreadWorker<T>.)

Methods

	Name	Description
Protected method	CreateThreadSettings	Creates ThreadSettings object and enables the IsBackground and UseEmptyContext properties. (Inherited from ThreadWorker<T>.)
Public method	Dispose()	Disposes instance of thread worker. (Inherited from ThreadWorker<T>.)
Protected method	Dispose(Boolean)	Disposes instance of thread worker. (Inherited from ThreadWorker<T>.)
Protected method	DoMaintenance	Runs the maintenance routine for the worker (Inherited from ThreadWorker<T>.)
Public method	Enqueue	Adds new item to processing queue.
Public method	EnsureRunningThread	Ensures a running thread for this processor (Inherited from ThreadWorker<T>.)
Protected method	Finish	Finishes the worker process. (Inherited from ThreadWorker<T>.)
Protected method	Initialize	Initializes the worker. Runs in the worker thread before the thread processes the first iteration. (Inherited from ThreadWorker<T>.)
Public method	IsThreadRunning	Returns true if the worker thread is currently running (Inherited from ThreadWorker<T>.)
Protected method	Process	Method processing queued actions. (Overrides ThreadWorker<T>.Process().)
Protected method	ProcessItem	Processes the item in the queue. Override this method to process a single item from the queue.
Protected method	ProcessItems	Processes the given list of items. Override this method to process queued items as a bulk. Returns the number of processed items.
Protected method	RunProcess	Runs the internal process of the worker (Inherited from ThreadWorker<T>.)
Protected method	StopExecution	Stops the worker after finishing its job. (Inherited from ThreadWorker<T>.)