CMSThread Class

Wrapper class for Thread object with additional debug, log and context item possibilities.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractWorker
    CMS.Base.CMSThread

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

Syntax

public sealed class CMSThread : AbstractWorker

The CMSThread type exposes the following members.

Constructors

	Name	Description
Public method	CMSThread(ThreadStart, ThreadSettings)	Creates new instance of CMSThread.
Public method	CMSThread(ThreadStart, Boolean, ThreadModeEnum)	Creates new instance of CMSThread.

Fields

	Name	Description
Public field Static member	ABORT_REASON_STOP	Thread was stopped by the user.

Properties

	Name	Description
Public property	AllowAsyncActions	Indicates if new threads can be created within this thread. (By default no new threads are created.)
Public property	ConnectionString	Connection string name that the thread should use to access the database
Public property	IsBackground	Defines if a thread is a background thread
Public property	Log	Logs for long running operations.
Public property	Mode	If true, the thread runs synchronously
Public property	Priority	Specifies the scheduling priority.
Public property	RunInSequence	If true, the thread is a part of the sequence and should perform the actions after the previous thread finishes. (Inherited from AbstractWorker.)
Public property Static member	RunningThreads	Counter of running Threads.
Public property	ThreadFinished	Time when the thread finished.
Public property	ThreadGUID	Thread GUID.
Public property	ThreadID	Thread ID.
Public property	ThreadStarted	Time when the thread started.

Methods

	Name	Description
Public method	Abort	Raises a ThreadAbortException in the thread on which it is invoked, to begin the process of terminating the thread. Calling this method usually terminates the thread.
Public method Static member	AllowEmptyContext	Allows anonymous thread to use new dedicated context in subsequent calls. Call this method in case the anonymous thread isn't initiated from a request thread, or in case you want to start with an empty thread context on purpose.
Public method Static member	GetCurrentThreadId	Gets the current thread ID
Public method Static member	GetThread	Finds the thread based on the given GUID.
Public method	Join	Blocks the calling thread until a thread terminates, while continuing to perform standard COM and SendMessage pumping.
Public method	LoadTargetDelegateInfo	Sets the target delegate information
Protected method	RaiseStop	Raises OnStop event. (Inherited from AbstractWorker.)
Public method	Run	Runs the action. (Overrides AbstractWorker.Run().)
Public method	RunAsync	Runs the worker as a new thread. For internal purposes only, use method Start instead. (Overrides AbstractWorker.RunAsync().)
Public method	Start	Starts the thread.
Public method	Stop	Stops the thread execution.
Public method Static member	Stopped	Returns true if thread was aborted with ABORT_REASON_STOP state info e.g. Thread.Abort(CMSThread.ABORT_REASON_STOP);
Public method Static member	Wrap(Action, Boolean)	Wraps the given method into CMSThread context
Public method Static member	Wrap<T>(Action<T>, Boolean)	Wraps the given method into CMSThread context
Public method Static member	Wrap<T1, T2>(Action<T1, T2>, Boolean)	Wraps the given method into CMSThread context
Public method Static member	WrapFunc<TResult>(Func<TResult>, Boolean)	Wraps the given method into CMSThread context
Public method Static member	WrapFunc<T1, TResult>(Func<T1, TResult>, Boolean)	Wraps the given method into CMSThread context

Events

	Name	Description
Public event	OnStop	Raised when worker finishes. (Inherited from AbstractWorker.)

Remarks

Based on the UseEmptyContext flag, the CMSThread starts with empty context items or copies context items from the parent thread. Only context items based on the AbstractContext<TContext> class are copied.