net.openhft.chronicle.core.jlbh

Class JLBHOptions

java.lang.Object

net.openhft.chronicle.core.jlbh.JLBHOptions

public class JLBHOptions
extends Object

Data structure to store the options to pass into the JLBH constructor

Constructor Summary

Constructors

Constructor and Description
JLBHOptions()

Method Summary

Modifier and Type	Method and Description
JLBHOptions	accountForCoordinatedOmmission(boolean accountForCoordinatedOmmission) Determines whether the start time is the time the event was supposed to have happened (i.e.
JLBHOptions	iterations(int iterations) Number of iterations of the benchmark not including warmup.
JLBHOptions	jitterAffinity(boolean jitterAffinity) Should the jitter thread set affinity or not
JLBHOptions	jlbhTask(JLBHTask JLBHTask) The latency benchmark to be run.
JLBHOptions	pauseAfterWarmupMS(int pauseMS) Option to set a pause after the warmup is complete
JLBHOptions	recordJitterGreaterThanNs(int recordJitterGreaterThanNs) Determines how much jitter to record.
JLBHOptions	recordOSJitter(boolean recordOSJitter) Determines whether or not to record jitter
JLBHOptions	runs(int runs) Number of runs of the benchmark
JLBHOptions	skipFirstRun(boolean skip) Option to skip first run from being included in the variation statistics.
JLBHOptions	throughput(int throughput) Number of iterations per second to be pushed through the benchmark
JLBHOptions	warmUpIterations(int warmUp) Determines how many warmup iterations to perform.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JLBHOptions

public JLBHOptions()

Method Detail

throughput

public JLBHOptions throughput(int throughput)

Number of iterations per second to be pushed through the benchmark

Parameters:

throughput - defaults to 10,000

Returns:

Instance of the JLBHOptions to be used in the builder pattern.

accountForCoordinatedOmmission

public JLBHOptions accountForCoordinatedOmmission(boolean accountForCoordinatedOmmission)

Determines whether the start time is the time the event was supposed to have happened (i.e. accounting for co-ordinated ommission) or whether the the start time is just the a factor of the throughput (i.e. not accounting for co-ordinated ommission).

Parameters:

accountForCoordinatedOmmission - defaults to true

Returns:

Instance of the JLBHOptions to be used in the builder pattern.

recordJitterGreaterThanNs

public JLBHOptions recordJitterGreaterThanNs(int recordJitterGreaterThanNs)

Determines how much jitter to record.

Parameters:

recordJitterGreaterThanNs - Defaults to 1000

Returns:

Instance of the JLBHOptions to be used in the builder pattern.

recordOSJitter

public JLBHOptions recordOSJitter(boolean recordOSJitter)

Determines whether or not to record jitter

Parameters:

recordOSJitter - Defaults to true

Returns:

Instance of the JLBHOptions to be used in the builder pattern.

warmUpIterations

public JLBHOptions warmUpIterations(int warmUp)

Determines how many warmup iterations to perform. Note: warmup iterations are continuous.

Parameters:

warmUp - Defaults to 10,000

Returns:

Instance of the JLBHOptions to be used in the builder pattern.

runs

public JLBHOptions runs(int runs)

Number of runs of the benchmark

Parameters:

runs - Defaults to 3

Returns:

Instance of the JLBHOptions to be used in the builder pattern.

iterations

public JLBHOptions iterations(int iterations)

Number of iterations of the benchmark not including warmup.

Parameters:

iterations - Defaults to 100,000

Returns:

Instance of the JLBHOptions to be used in the builder pattern.

jlbhTask

public JLBHOptions jlbhTask(JLBHTask JLBHTask)

The latency benchmark to be run.

Parameters:

JLBHTask -

Returns:

Instance of the JLBHOptions to be used in the builder pattern.

pauseAfterWarmupMS

public JLBHOptions pauseAfterWarmupMS(int pauseMS)

Option to set a pause after the warmup is complete

Parameters:

pauseMS - pause in ms default to 0

Returns:

Instance of the JLBHOptions to be used in the builder pattern.

skipFirstRun

public JLBHOptions skipFirstRun(boolean skip)

Option to skip first run from being included in the variation statistics.

Parameters:

skip - defult to true if runs greater than 3

Returns:

Instance of the JLBHOptions to be used in the builder pattern.

jitterAffinity

public JLBHOptions jitterAffinity(boolean jitterAffinity)

Should the jitter thread set affinity or not

Parameters:

jitterAffinity - default is false

Returns:

Instance of the JLBHOptions to be used in the builder pattern.