WorkCollector Class

WorkCollector Class

Class which collects work to be done later in the form of WorkItem instances.

Inheritance Hierarchy

SystemObject
SD.LLBLGen.Pro.ApplicationCore.WorkBrokerWorkCollector

Namespace: SD.LLBLGen.Pro.ApplicationCore.WorkBroker
Assembly: SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.2.0.0 (5.2.17.0403)

Syntax

Copy

public class WorkCollector

Public Class WorkCollector

The WorkCollector type exposes the following members.

Constructors

	Name	Description
	WorkCollector	Initializes a new instance of the WorkCollector class.

Top

Properties

	Name	Description
	Count	Gets the number of work items queued in this instance.
	SubTaskProgressInitHandler	The handler of the SubTaskProgressInitCallBack. Setting this property will allow Start to reflect its current progress of subtasks executed within a general task in the progress viewer.
	SubTaskProgressTaskCompletedHandler	The handler of the SubTaskProgressTaskCompletedCallBack. Setting this property will allow Start to reflect its current progress of subtasks executed within a general task in the progress viewer.
	SubTaskProgressTaskStartHandler	The handler of the SubTaskProgressTaskStartCallBack. Setting this property will allow Start to reflect its current progress of subtasks executed within a general task in the progress viewer.
	TaskProgressInitHandler	The handler of the TaskProgressInitCallBack. Setting this property will allow Start to reflect its current progress of general tasks in the progress viewer.
	TaskProgressTaskCompletedHandler	The handler of the TaskProgressTaskCompletedCallBack. Setting this property will allow Start to reflect its current progress of general tasks in the progress viewer.
	TaskProgressTaskStartHandler	The handler of the TaskProgressTaskStartCallBack. Setting this property will allow Start to reflect its current progress of general tasks in the progress viewer.

Top

Methods

	Name	Description
	AddWork	Adds the work specified.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PerformWork	Performs the work.
	SetCallBacks	Sets the call backs to use for this generator
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Not thread safe, meaning when this collector is performing work, it assumes no new work is added to it. This can be changed easily though: a lock has to be added to make Add and PerformWork wait for each other when accessing the queue.

Reference

SD.LLBLGen.Pro.ApplicationCore.WorkBroker Namespace