SynchronizationQueueWorker Class

Queue worker for processing of synchronization tasks

Inheritance Hierarchy

System.Object
  CMS.Base.ThreadWorker<SynchronizationQueueWorker>
    CMS.Base.ThreadQueueWorker<SimpleQueueItem, SynchronizationQueueWorker>
      CMS.Base.SimpleQueueWorker<SynchronizationQueueWorker>
        CMS.Synchronization.SynchronizationQueueWorker

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

Syntax

public class SynchronizationQueueWorker : SimpleQueueWorker<SynchronizationQueueWorker>

The SynchronizationQueueWorker type exposes the following members.

Constructors

	Name	Description
Public method	SynchronizationQueueWorker

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. (Inherited from SimpleQueueWorker<T>.)
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. (Inherited from SimpleQueueWorker<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	Turns off thread in case of inactivity. (Inherited from SimpleQueueWorker<T>.)
Public method	Enqueue(Action)	Enqueue action with random unique key. (Inherited from SimpleQueueWorker<T>.)
Public method	Enqueue(String, Action)	Enqueue action with given key. (Inherited from SimpleQueueWorker<T>.)
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. (Inherited from SimpleQueueWorker<T>.)
Protected method	Initialize	Initialize item counter event. (Inherited from SimpleQueueWorker<T>.)
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. (Inherited from SimpleQueueWorker<T>.)
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. (Overrides ThreadQueueWorker<TItem, TWorker>.ProcessItems(IEnumerable<TItem>).)
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>.)