OpenSim.Framework.Monitoring.JobEngine.Job Class Reference

Static Public Member Functions
static Job	MakeJob (string name, Action action, string commonId=null)
	Make a job. It needs to be separately queued. More...

Properties
string	Name [get, set]
	Name of the job. More...
string	CommonId [get, set]
	Common ID for this job. More...
Action	Action [get, set]
	Action to perform when this job is processed. More...

Detailed Description

Definition at line 276 of file JobEngine.cs.

Member Function Documentation

static Job OpenSim.Framework.Monitoring.JobEngine.Job.MakeJob ( string  name, Action  action, string  commonId = null  )

inlinestatic

Make a job. It needs to be separately queued.

We provide this method to replace the constructor so that we can pool job objects if necessary to to reduce memory churn. Normally one would directly call JobEngine.QueueJob() with parameters anyway.

Returns

Parameters

name	Name.
action	Action.
commonId	Common identifier.

Definition at line 318 of file JobEngine.cs.

Property Documentation

Action OpenSim.Framework.Monitoring.JobEngine.Job.Action

getset

Action to perform when this job is processed.

Definition at line 298 of file JobEngine.cs.

string OpenSim.Framework.Monitoring.JobEngine.Job.CommonId

getset

Common ID for this job.

This allows all jobs with a certain common ID (e.g. a client UUID) to be removed en-masse if required. Can be null if this is not required.

Definition at line 293 of file JobEngine.cs.

string OpenSim.Framework.Monitoring.JobEngine.Job.Name

getset

Name of the job.

This appears on console and debug output.

Definition at line 284 of file JobEngine.cs.

---

The documentation for this class was generated from the following file:

• Framework/Monitoring/JobEngine.cs