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: 13.0.131

Syntax

public abstract class ThreadWorker<T> : IDisposable
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
Protected field	SyncRoot	Lock this object when doing actions that might change the result of condition run while stopping execution

Properties

	Name	Description
Public property Static member	Current	Current thread worker object
Protected property	DefaultInterval	Gets the default interval in milliseconds for the worker.
Protected property	MaintenanceInterval	Gets the maintenance interval in milliseconds for the worker. When 0 (default), the maintenance is not performed.
Protected property	PollThread	Gets or sets thread which is periodically checking for new tasks.
Public property	ProcessingPaused	Indicates whether worker routine is temporarily paused.
Protected property	StopRequestToken	The CancellationToken to be checked if the thread should stop execution.
Protected property	UseLogContext	If true, the thread uses a log context for its operations

Methods

	Name	Description
Protected method	CreateThreadSettings	Creates ThreadSettings object and enables the IsBackground and UseEmptyContext properties.
Public method	Dispose()	Disposes instance of thread worker.
Protected method	Dispose(Boolean)	Disposes instance of thread worker.
Protected method	DoMaintenance	Runs the maintenance routine for the worker
Public method	EnsureRunningThread	Ensures a running thread for this processor
Protected method	Finish	Finishes the worker process.
Protected method	Initialize	Initializes the worker. Runs in the worker thread before the thread processes the first iteration.
Public method	IsThreadRunning	Returns true if the worker thread is currently running
Protected method	Process	Method processing actions.
Protected method	RunProcess	Runs the internal process of the worker
Protected method	StopExecution	Stops the worker after finishing its job.