CMSWorkerQueue Class

Queue of the workers.

Inheritance Hierarchy

System.Object
  System.Collections.Generic.Queue<AbstractWorker>
    CMS.Base.CMSWorkerQueue

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

Syntax

public class CMSWorkerQueue : Queue<AbstractWorker>, 
	INotCopyThreadItem

The CMSWorkerQueue type exposes the following members.

Constructors

	Name	Description
Public method	CMSWorkerQueue

Methods

	Name	Description
Protected method	AddWorker	Adds the given worker to the queue.
Protected method	CheckWait	Returns true if the queue processing should wait
Public method Static member	QueueWorker(AbstractWorker)	Adds the given worker to the queue for current request. The workers get executed upon the end of current request or thread or explicit call to RunQueuedWorkers.
Public method Static member	QueueWorker(Action, String)	Adds given action to the CMSWorkerQueue as an ActionWorker.
Public method	RunAll	Runs all the workers.
Public method Static member	RunCurrentQueuedWorkers	Runs the workers queued in current request.
Public method Static member	RunGlobalQueuedWorkers	Runs the global queued workers
Protected method	RunThreadsWaiting	Runs the threads waiting for the execution of the next allowed threads
Protected method	RunWorkers	Runs the threads in current instance
Protected method	worker_OnStop	Handles worker's OnStop event.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mDuplicities	Table of existing duplicity keys for current queue.
Protected field	mRunningCount	Number of running threads
Protected field	mTotalRunningCount	Number of running threads from all queues

Properties

	Name	Description
Protected property	Closed	If true, the queue is already closed.
Protected property	Duplicities	Table of existing duplicity keys for current queue.
Public property Static member	Global	Gets the global worker queue.
Public property Static member	Instance	Gets or sets current worker queue.
Public property	Parameters	Gets or sets parameters of the queue, parameters are indexed by their name.
Public property	RunInSeparateThread	If true, the worker queue set to run workers synchronously runs in a single separate thread.
Public property	RunningCount	Number of currently running workers.
Public property	RunWorkersSynchronously	If true, the worker queue executes the workers one by one synchronously
Public property	TotalRunningCount	Number of currently running workers from all queues.