Click or drag to resize
SimpleQueueWorkerT Class
Worker for running various simple asynchronous actions.
Inheritance Hierarchy
SystemObject
  CMS.BaseThreadWorkerT
    CMS.BaseThreadQueueWorkerSimpleQueueItem, T
      CMS.BaseSimpleQueueWorkerT
        CMS.ContactManagementScoreQueueWorker
        CMS.SynchronizationSynchronizationQueueWorker
        CMS.WorkflowEngineWorkflowActionQueueWorker

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 12.0.0
Syntax
C#
public abstract class SimpleQueueWorker<T> : ThreadQueueWorker<SimpleQueueItem, T>
where T : new(), SimpleQueueWorker<T>

Type Parameters

T

The SimpleQueueWorkerT type exposes the following members.

Constructors
Fields
Properties
  NameDescription
Protected propertyCheckDuplicity
If true, the queue checks the duplicity when inserting items. The duplicity is checked using the default comparer of the item.
(Inherited from ThreadQueueWorkerTItem, TWorker.)
Protected propertyDefaultInterval
Default interval of processing cycle.
(Overrides ThreadWorkerTDefaultInterval.)
Public propertyItemsInQueue
Return the current number of items in the queue
(Inherited from ThreadQueueWorkerTItem, TWorker.)
Protected propertyMaintenanceInterval
Maintenance interval for turning off the thread.
(Overrides ThreadWorkerTMaintenanceInterval.)
Protected propertyPollThread
Gets or sets thread which is periodically checking for new tasks.
(Inherited from ThreadWorkerT.)
Public propertyProcessingPaused
Indicates whether worker routine is temporarily paused.
(Inherited from ThreadWorkerT.)
Protected propertyUseLogContext
If true, the thread uses a log context for its operations
(Inherited from ThreadWorkerT.)
Top
Methods
  NameDescription
Protected methodCreateThreadSettings
Creates ThreadSettings object and enables the IsBackground and UseEmptyContext properties.
(Inherited from ThreadWorkerT.)
Public methodDispose
Disposes instance of thread worker.
(Inherited from ThreadWorkerT.)
Protected methodDispose(Boolean)
Disposes instance of thread worker.
(Inherited from ThreadWorkerT.)
Protected methodDoMaintenance
Turns off thread in case of inactivity.
(Overrides ThreadWorkerTDoMaintenance.)
Public methodEnqueue(Action)
Enqueue action with random unique key.
Public methodEnqueue(String, Action)
Enqueue action with given key.
Public methodEnqueue(TItem, Boolean)
Adds new item to processing queue.
(Inherited from ThreadQueueWorkerTItem, TWorker.)
Public methodEnsureRunningThread
Ensures a running thread for this processor
(Inherited from ThreadWorkerT.)
Protected methodFinish
Finishes the worker process.
(Overrides ThreadWorkerTFinish.)
Protected methodInitialize
Initialize item counter event.
(Overrides ThreadWorkerTInitialize.)
Public methodIsThreadRunning
Returns true if the worker thread is currently running
(Inherited from ThreadWorkerT.)
Protected methodProcess
Method processing queued actions.
(Inherited from ThreadQueueWorkerTItem, TWorker.)
Protected methodProcessItem
Processing of single action.
(Overrides ThreadQueueWorkerTItem, TWorkerProcessItem(TItem).)
Protected methodProcessItems
Processes the given list of items. Override this method to process queued items as a bulk. Returns the number of processed items.
(Inherited from ThreadQueueWorkerTItem, TWorker.)
Protected methodRunProcess
Runs the internal process of the worker
(Inherited from ThreadWorkerT.)
Protected methodStopExecution
Stops the worker after finishing its job.
(Inherited from ThreadWorkerT.)
Top
Remarks
Duplicity of items being enqueued is checks by Key.
See Also