ThreadWorker<T> Class

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

Inheritance Hierarchy

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

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

Syntax

public abstract class ThreadWorker<T>
where T : new(), ThreadWorker<T>

Type Parameters

T

The ThreadWorker<T> type exposes the following members.

Constructors

	Name	Description
Protected method	ThreadWorker<T>

Fields

	Name	Description
Protected field Static member	LOG_MAX_LENGTH	Maximum length of the worker log to prevent memory leaks (100kB by default)

Properties

	Name	Description
Protected property Static member	Current	Current thread worker object
Protected property	DefaultInterval	Gets the default interval in milliseconds for the worker.
Protected property	LastRun	Last run time
Protected property Static member	Log	Asynchronous log context used by the worker thread
Protected property	MaintenanceInterval	Gets the maintenance interval in milliseconds for the worker. When 0 (default), the maintenance is not performed.
Protected property	NextMaintenance	Next maintenance time
Protected property	PollThread	Gets or sets thread which is periodically checking for new tasks.
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

Methods

	Name	Description
Public method Static member	Abort	Aborts the worker
Protected method	AbortInternal	Aborts the worker
Protected method	CreateThread	Creates a worker thread object. Override to modify the thread configuration
Protected method	DoMaintenance	Runs the maintenance routine for the worker
Public method Static member	EnsureRunningThread	Ensures a running thread for this processor
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.
Protected method	Initialize	Initializes the worker. Runs in the worker thread before the thread processes the first iteration.
Public method Static member	IsThreadRunning	Returns true if the worker thread is currently running
Protected method	Process	Method processing actions.
Public method Static member	Register	Registers the worker so that it runs within the system
Protected method	RegisterInternal	Registers the worker
Public method Static member	Reset	Obsolete. Resets the worker
Protected method	ResetInternal	Obsolete. Resets the worker
Protected method	Run	Runs the action.
Protected method	RunAsync	Runs the task in an asynchronous thread.
Protected method	RunMaintenance	Runs the maintenance routine for the worker if it should run.
Protected method	RunProcess	Runs the internal process of the worker
Public method Static member	StopExecution	Stops the worker after finishing its job