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.EventLog.EventLogWorker
      CMS.WebFarmSync.WebFarmUpdaterAsync

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

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>

Methods

	Name	Description
Public method Static member	ClearQueue	Clears the current queue
Protected method	CreateThread	Creates a worker thread object. Override to modify the thread configuration (Inherited from ThreadWorker<T>.)
Protected method	Dequeue	Returns the first item in the queue and removes it
Protected method	DoMaintenance	Runs the maintenance routine for the worker (Inherited from ThreadWorker<T>.)
Public method Static member	Enqueue	Adds new item to processing queue
Protected method	Finish	Finishes the worker process. Implement this method to specify what the worker must do in order to not lose its internal data when being finished. Leave empty if no extra action is required. (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>.)
Protected method	Process	Method processing queues 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	RegisterInternal	Registers the worker (Inherited from ThreadWorker<T>.)
Protected method	ResetInternal	Resets the worker and clears the queue (Overrides ThreadWorker<T>.ResetInternal().)
Protected method	Run	Runs the action. (Inherited from ThreadWorker<T>.)
Protected method	RunAsync	Runs the task in an asynchronous thread. (Inherited from ThreadWorker<T>.)
Protected method	RunMaintenance	Runs the maintenance routine for the worker if it should run. (Inherited from ThreadWorker<T>.)
Protected method	RunProcess	Runs the internal process of the worker (Inherited from ThreadWorker<T>.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	Events	Events fired by the worker

Properties

	Name	Description
Protected property	DefaultInterval	Gets the default interval in milliseconds for the worker. (Inherited from ThreadWorker<T>.)
Protected property	CheckDuplicity	If true, the queue checks the duplicity when inserting items. The duplicity is checked using the default comparer of the item.
Public property Static member	ItemsInQueue	Return the current number of items in the queue
Protected property	LastRun	Last run time (Inherited from ThreadWorker<T>.)
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	NextMaintenance	Next maintenance time (Inherited from ThreadWorker<T>.)
Protected property	PollThread	Gets or sets thread which is periodically checking for new tasks. (Inherited from ThreadWorker<T>.)
Public property Static member	ProcessingPaused	If set to true, tasks from queue will not be processed.
Protected property	UseLogContext	If true, the thread uses a log context for its operations (Inherited from ThreadWorker<T>.)