SimpleQueueWorker<T> Class

Worker for running various simple asynchronous actions.

Inheritance Hierarchy

System.Object
  CMS.Base.ThreadWorker<T>
    CMS.Base.ThreadQueueWorker<SimpleQueueItem, T>
      CMS.Base.SimpleQueueWorker<T>
        CMS.ContactManagement.ScoreQueueWorker
        CMS.Synchronization.SynchronizationQueueWorker
        CMS.WorkflowEngine.WorkflowActionQueueWorker

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

Syntax

public abstract class SimpleQueueWorker<T> : ThreadQueueWorker<SimpleQueueItem, T>
where T : new(), SimpleQueueWorker<T>

Type Parameters

T

The SimpleQueueWorker<T> type exposes the following members.

Constructors

	Name	Description
Protected method	SimpleQueueWorker<T>

Fields

	Name	Description
Public field	Events	Events fired by the worker (Inherited from ThreadQueueWorker<TItem, TWorker>.)
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. (Inherited from ThreadQueueWorker<TItem, TWorker>.)
Protected property	DefaultInterval	Default interval of processing cycle. (Overrides ThreadWorker<T>.DefaultInterval.)
Public property	ItemsInQueue	Return the current number of items in the queue (Inherited from ThreadQueueWorker<TItem, TWorker>.)
Protected property	MaintenanceInterval	Maintenance interval for turning off the thread. (Overrides ThreadWorker<T>.MaintenanceInterval.)
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	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	Turns off thread in case of inactivity. (Overrides ThreadWorker<T>.DoMaintenance().)
Public method	Enqueue(Action)	Enqueue action with random unique key.
Public method	Enqueue(String, Action)	Enqueue action with given key.
Public method	Enqueue(TItem, Boolean)	Adds new item to processing queue. (Inherited from ThreadQueueWorker<TItem, TWorker>.)
Public method	EnsureRunningThread	Ensures a running thread for this processor (Inherited from ThreadWorker<T>.)
Protected method	Finish	Finishes the worker process. (Overrides ThreadWorker<T>.Finish().)
Protected method	Initialize	Initialize item counter event. (Overrides ThreadWorker<T>.Initialize().)
Public method	IsThreadRunning	Returns true if the worker thread is currently running (Inherited from ThreadWorker<T>.)
Protected method	Process	Method processing queued actions. (Inherited from ThreadQueueWorker<TItem, TWorker>.)
Protected method	ProcessItem	Processing of single action. (Overrides ThreadQueueWorker<TItem, TWorker>.ProcessItem(TItem).)
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. (Inherited from ThreadQueueWorker<TItem, TWorker>.)
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>.)

Remarks

Duplicity of items being enqueued is checks by Key.