SolidFramework.Services.JobProcessor Class Reference

Represents types of Job Processor. More...

Inheritance diagram for SolidFramework.Services.JobProcessor:

Public Member Functions
	JobProcessor ()
	Initializes a new instance of the JobProcessor class.
	JobProcessor (string jobHandlerPath, string jobHandlerArguments="")
	Initializes a new instance of the JobProcessor class with a specific JobHandler. More...
void	ResetStatistics ()
	Resets and clears the statistic counters that provide information about the number and state of conversions that were allocated to this JobProcessor.
ReadOnlyCollection< WorkerStatistics >	GetStatistics ()
	Gets a read only collection of the statistics about the conversions that were allocated to this JobProcessor. More...
void	ClearRemainingQueue (bool triggerEvents=false)
	Clears the remaining queue. More...
void	RemoveJobFromDupList (int jobId)
	Remove a job from the Duplicate list. More...
virtual void	Log (string message)
void	SubmitJob (JobEnvelope jobEnvelope)
	Submits the job. More...
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
void	WaitTillComplete ()
	Waits the till complete.
bool	IsBusy ()
	Determines whether this instance is busy. More...
void	Kill ()
	Kills this instance.
void	Close ()
	Closes this instance.

Static Public Member Functions
static void	WorkerMain ()
	Workers the main.

Properties
bool	KeepJobs [getset]
	Gets or sets a value indicating whether keep jobs. More...
bool	Allow64on32 [getset]
	Gets or sets a value indicating whether to run 64 bit job handlers from a 32 user application on a 64 bit OS. More...
ReadOnlyCollection< JobEnvelope >	ProcessedJobs [get]
	Gets the list of processed jobs. More...
bool	DuplicateChecking [getset]
int	WorkerCount [getset]
	Gets or sets the worker count. More...
int	WorkerJobsBeforeRecycle [getset]
	Gets or sets the number of conversions that should be handled by a single WorkerProcess before it is killed and replaced. The default value is 100.
TimeSpan	WorkerTimeOut [getset]
	Gets or sets the worker time out. More...
int	QueuedJobs [get]
	Gets the number of jobs in the queue
int	TotalJobs [getset]
	Gets or sets the total jobs. More...
bool	Running [getset]
	Gets or sets whether the JobProcessor is running. More...

Events
EventHandler< JobProgressEventArgs >	JobProgressEvent
	Occurs when job progress event is raised.
EventHandler< JobCompletedEventArgs >	JobCompletedEvent
	Occurs when a job is completed.
EventHandler< QueueEmptyEventArgs >	QueueEmptyEvent
	Occurs when the job queue becomes empty.

Detailed Description

Represents types of Job Processor.

Constructor & Destructor Documentation

JobProcessor()

SolidFramework.Services.JobProcessor.JobProcessor	(	string	jobHandlerPath,
		string	jobHandlerArguments = ""
	)

Initializes a new instance of the JobProcessor class with a specific JobHandler.

Parameters

jobHandlerPath	The path to the JobHandler executable that will be doing the work
jobHandlerArguments	The command line arguments to provide the JobHandler executable, "{WorkerNumber}" will be substituted with the worker number

Member Function Documentation

ClearRemainingQueue()

void SolidFramework.Services.JobProcessor.ClearRemainingQueue

(

bool

triggerEvents = false

)

Clears the remaining queue.

Parameters

triggerEvents

Whether JobCompletedEvent should fire for the cancelled jobs

GetStatistics()

ReadOnlyCollection< WorkerStatistics > SolidFramework.Services.JobProcessor.GetStatistics

(

)

Gets a read only collection of the statistics about the conversions that were allocated to this JobProcessor.

Returns

IsBusy()

bool SolidFramework.Services.JobProcessor.IsBusy

(

)

Determines whether this instance is busy.

Returns

true if this instance is busy; otherwise, false.

RemoveJobFromDupList()

void SolidFramework.Services.JobProcessor.RemoveJobFromDupList

(

int

jobId

)

Remove a job from the Duplicate list.

Parameters

jobId

SubmitJob()

void SolidFramework.Services.JobProcessor.SubmitJob

(

JobEnvelope

jobEnvelope

)

Submits the job.

Parameters

jobEnvelope

The job envelope.

Property Documentation

Allow64on32

bool SolidFramework.Services.JobProcessor.Allow64on32

getset

Gets or sets a value indicating whether to run 64 bit job handlers from a 32 user application on a 64 bit OS.

true if running 64 bit JobHandler on a 32 bit JobProcesser is allowed; otherwise, false.

KeepJobs

bool SolidFramework.Services.JobProcessor.KeepJobs

getset

Gets or sets a value indicating whether keep jobs.

true if keep jobs; otherwise, false.

ProcessedJobs

ReadOnlyCollection<JobEnvelope> SolidFramework.Services.JobProcessor.ProcessedJobs

get

Gets the list of processed jobs.

The processed jobs.

Running

bool SolidFramework.Services.JobProcessor.Running

getset

Gets or sets whether the JobProcessor is running.

This property will generally remain true once it has been set. Use IsBusy to identify whether processing has completed, or use the QueueEmptyEvent to identify when processing completes.

TotalJobs

int SolidFramework.Services.JobProcessor.TotalJobs

getset

Gets or sets the total jobs.

The total jobs.

WorkerCount

int SolidFramework.Services.JobProcessor.WorkerCount

getset

Gets or sets the worker count.

The worker count.

WorkerTimeOut

TimeSpan SolidFramework.Services.JobProcessor.WorkerTimeOut

getset

Gets or sets the worker time out.

The worker time out.