net.openhft.chronicle.jlbh

Class JLBHOptions

java.lang.Object

net.openhft.chronicle.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
@NotNull JLBHOptions	accountForCoordinatedOmission(boolean accountForCoordinatedOmission) Determines whether the start time is the time the event was supposed to have happened (i.e.
@NotNull JLBHOptions	accountForCoordinatedOmmission(boolean accountForCoordinatedOmission) Deprecated.
JLBHOptions	acquireLock(Supplier<net.openhft.affinity.AffinityLock> acquireLock)
@NotNull JLBHOptions	iterations(int iterations) Number of iterations of the benchmark not including warmup.
@NotNull JLBHOptions	iterations(long iterations)
@NotNull JLBHOptions	jitterAffinity(boolean jitterAffinity) Should the jitter thread set affinity or not
@NotNull JLBHOptions	jlbhTask(JLBHTask JLBHTask) The latency benchmark to be run.
JLBHOptions	latencyDistributor(LatencyDistributor latencyDistributor) Allow the distribution to be altered pseudo-randomly
@NotNull JLBHOptions	pauseAfterWarmupMS(int pauseMS) Option to set a pause after the warmup is complete
@NotNull JLBHOptions	recordJitterGreaterThanNs(int recordJitterGreaterThanNs) Determines how much jitter to record.
@NotNull JLBHOptions	recordOSJitter(boolean recordOSJitter) Determines whether or not to record jitter
@NotNull JLBHOptions	runs(int runs) Number of runs of the benchmark
@NotNull JLBHOptions	skipFirstRun(boolean skip) Option to skip first run from being included in the variation statistics.
@NotNull JLBHOptions	throughput(int throughput) Number of iterations per second to be pushed through the benchmark
@NotNull JLBHOptions	throughput(int throughput, TimeUnit throughputTimeUnit) Number of iterations per time unit to be pushed through the benchmark
JLBHOptions	timeout(long timeout)
@NotNull 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

@NotNull
public @NotNull 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.

throughput

@NotNull
public @NotNull JLBHOptions throughput(int throughput,
                                                TimeUnit throughputTimeUnit)

Number of iterations per time unit to be pushed through the benchmark

Parameters:

throughput - defaults to 10,000

throughputTimeUnit - defaults to TimeUnit.SECOND

Returns:

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

latencyDistributor

public JLBHOptions latencyDistributor(LatencyDistributor latencyDistributor)

Allow the distribution to be altered pseudo-randomly

Parameters:

latencyDistributor - function to take the average latency and multiply it by a function.

accountForCoordinatedOmission

@NotNull
public @NotNull JLBHOptions accountForCoordinatedOmission(boolean accountForCoordinatedOmission)

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

Parameters:

accountForCoordinatedOmission - defaults to true

Returns:

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

accountForCoordinatedOmmission

@Deprecated
 @NotNull
public @NotNull JLBHOptions accountForCoordinatedOmmission(boolean accountForCoordinatedOmission)

Deprecated.

recordJitterGreaterThanNs

@NotNull
public @NotNull 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

@NotNull
public @NotNull 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

@NotNull
public @NotNull 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

@NotNull
public @NotNull 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

@NotNull
public @NotNull 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.

iterations

@NotNull
public @NotNull JLBHOptions iterations(long iterations)

jlbhTask

@NotNull
public @NotNull JLBHOptions jlbhTask(JLBHTask JLBHTask)

The latency benchmark to be run.

Returns:

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

pauseAfterWarmupMS

@NotNull
public @NotNull 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

@NotNull
public @NotNull JLBHOptions skipFirstRun(boolean skip)

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

Parameters:

skip - default to true if runs greater than 3

Returns:

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

jitterAffinity

@NotNull
public @NotNull 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.

acquireLock

public JLBHOptions acquireLock(Supplier<net.openhft.affinity.AffinityLock> acquireLock)

timeout

public JLBHOptions timeout(long timeout)