Class PerfTask

An abstract task to be tested for performance.

Inheritance

System.Object

PerfTask

AddDocTask

AddIndexesTask

AnalyzerFactoryTask

ClearStatsTask

CloseIndexTask

CloseReaderTask

CloseTaxonomyIndexTask

CloseTaxonomyReaderTask

CommitIndexTask

CommitTaxonomyIndexTask

ConsumeContentSourceTask

CreateIndexTask

CreateTaxonomyIndexTask

ForceMergeTask

NearRealtimeReaderTask

NewAnalyzerTask

NewCollationAnalyzerTask

NewLocaleTask

NewRoundTask

OpenIndexTask

OpenReaderTask

OpenTaxonomyIndexTask

OpenTaxonomyReaderTask

PrintReaderTask

ReadTask

ReadTokensTask

ReopenReaderTask

ReportTask

ResetInputsTask

RollbackIndexTask

SetPropTask

TaskSequence

UpdateDocTask

WaitForMergesTask

WaitTask

WriteLineDocTask

Implements

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Lucene.Net.Benchmarks.ByTask.Tasks

Assembly: Lucene.Net.Benchmark.dll

Syntax

public abstract class PerfTask : IDisposable

Remarks

Every performance task extends this class, and provides its own DoLogic() method, which performs the actual task.

Tasks performing some work that should be measured for the task, can override Setup() and/or TearDown() and place that work there.

Relevant properties:

• task.max.depth.log

Also supports the following logging attributes:

• log.step specifies how often to log messages about the current running task. Default is 1000 DoLogic() invocations. Set to -1 to disable logging.
• log.step.[class Task Name] specifies the same as 'log.step', only for a particular task name. For example, log.step.AddDoc will be applied only for AddDocTask. It's a way to control per task logging settings. If you want to omit logging for any other task, include log.step=-1. The syntax is "log.step." together with the Task's 'short' name (i.e., without the 'Task' part).

Constructors

PerfTask(PerfRunData)

Declaration

public PerfTask(PerfRunData runData)

Parameters

Type	Name	Description
PerfRunData	runData

Fields

m_logStep

Declaration

protected int m_logStep

Field Value

Type	Description
System.Int32

m_params

Declaration

protected string m_params

Field Value

Type	Description
System.String

NEW_LINE

Declaration

protected static readonly string NEW_LINE

Field Value

Type	Description
System.String

Properties

AlgLineNum

Declaration

public virtual int AlgLineNum { get; set; }

Property Value

Type	Description
System.Int32

BackgroundDeltaPriority

Declaration

public virtual int BackgroundDeltaPriority { get; }

Property Value

Type	Description
System.Int32

Depth

Gets or Sets the depth.

Declaration

public virtual int Depth { get; set; }

Property Value

Type	Description
System.Int32

DisableCounting

Return true if counting is disabled for this task.

Declaration

public virtual bool DisableCounting { get; set; }

Property Value

Type	Description
System.Boolean

Params

Gets the Params.

Declaration

public virtual string Params { get; }

Property Value

Type	Description
System.String

RunData

Gets the run data.

Declaration

public virtual PerfRunData RunData { get; }

Property Value

Type	Description
PerfRunData

RunInBackground

Declaration

public virtual bool RunInBackground { get; }

Property Value

Type	Description
System.Boolean

ShouldNeverLogAtStart

Tasks that should never log at start can override this. Returns true if this task should never log when it start.

Declaration

protected virtual bool ShouldNeverLogAtStart { get; }

Property Value

Type	Description
System.Boolean

ShouldNotRecordStats

Tasks that should not record statistics can override this. Returns true if this task should never record its statistics.

Declaration

protected virtual bool ShouldNotRecordStats { get; }

Property Value

Type	Description
System.Boolean

Stop

Declaration

protected bool Stop { get; set; }

Property Value

Type	Description
System.Boolean

SupportsParams

Sub classes that support parameters must override this method to return true if this task supports command line params.

Declaration

public virtual bool SupportsParams { get; }

Property Value

Type	Description
System.Boolean

Methods

Clone()

Declaration

public virtual object Clone()

Returns

Type	Description
System.Object

Dispose()

Declaration

public void Dispose()

Dispose(Boolean)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

DoLogic()

Perform the task once (ignoring repetitions specification). Return number of work items done by this task. For indexing that can be number of docs added. For warming that can be number of scanned items, etc.

Declaration

public abstract int DoLogic()

Returns

Type	Description
System.Int32	Number of work items done by this task.

GetLogMessage(Int32)

Declaration

protected virtual string GetLogMessage(int recsCount)

Parameters

Type	Name	Description
System.Int32	recsCount

Returns

Type	Description
System.String

GetName()

Returns the name.

Declaration

public virtual string GetName()

Returns

Type	Description
System.String

RunAndMaybeStats(Boolean)

Run the task, record statistics.

Declaration

public int RunAndMaybeStats(bool reportStats)

Parameters

Type	Name	Description
System.Boolean	reportStats

Returns

Type	Description
System.Int32	Number of work items done by this task.

SetName(String)

Sets the name.

Declaration

protected virtual void SetName(string name)

Parameters

Type	Name	Description
System.String	name	The name to set.

SetParams(String)

Set the params of this task.

Declaration

public virtual void SetParams(string params)

Parameters

Type	Name	Description
System.String	params

Exceptions

Type	Condition
System.NotSupportedException	For tasks supporting command line parameters.

SetRunInBackground(Int32)

Declaration

public virtual void SetRunInBackground(int deltaPri)

Parameters

Type	Name	Description
System.Int32	deltaPri

Setup()

Task setup work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work from DoLogic() to this method. Only the work done in DoLogic() is measured for this task. Notice that higher level (sequence) tasks containing this task would then measure larger time than the sum of their contained tasks.

Declaration

public virtual void Setup()

StopNow()

Declaration

public virtual void StopNow()

TearDown()

Task teardown work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work from DoLogic() to this method. Only the work done in DoLogic() is measured for this task. Notice that higher level (sequence) tasks containing this task would then measure larger time than the sum of their
contained tasks.

Declaration

public virtual void TearDown()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

Implements

System.IDisposable