CMSThread Class

CMS managed thread.

Inheritance Hierarchy

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

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

Syntax

public class CMSThread : AbstractWorker, IDisposable

The CMSThread type exposes the following members.

Constructors

	Name	Description
Public method	CMSThread(ThreadStart, ThreadSettings)	Constructor.
Public method	CMSThread(ThreadStart, Boolean, ThreadModeEnum)	Constructor.

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	Cancel	If true, the worker is cancelled (doesn't execute) (Inherited from AbstractWorker.)
Public property	ConnectionString	Connection string name that the thread should use to access the database
Public property	InnerThread	Worker object.
Public property	IsBackground	Defines if a thread is a background thread
Public property	Log	Logs for long running operations.
Public property	MethodClassName	Name of the class which is running the thread actions.
Public property	MethodName	Name of the method which is running the thread actions.
Public property	Mode	If true, the thread runs synchronously
Public property	Priority	Specifies the scheduling priority.
Public property	RequestUrl	Request URL which created the thread.
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	Aborts the thread execution. In case of sync mode thread, this method also kills all CMSThreads running under same InnerThread.
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.
Protected method	CloseThreadContext	Closes the thread context.
Public method	Dispose	Disposes the thread object.
Public method Static member	GetCurrentThreadId	Gets the current thread ID
Public method	GetDuplicityKey	Gets the duplicity key for the worker to eliminate duplicit queued workers. (Inherited from AbstractWorker.)
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	PrepareEmptyThreadContext	Prepares empty thread context for thread with UseEmptyContext set.
Protected method	PrepareThreadContext	Prepares the thread context
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 (doesn't log abort exception). In case of sync mode thread, this method only stops this and child synchronous threads. Parent threads running under same InnerThread will continue running.
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	WaitForSequence	Waits for the current sequence thread to terminate
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.)